WordPress / WordPress/phpdoc-parser

Parse array parameter docs

Open
#119 10 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

DevHub enhancement
Dominant language
PHP
Stars
239
Forks
81
Avg merge
16h 29m
Merged PRs (30d)
8

Description

Some of the parameter docs use lists. Markdown needs to be parsed in parameter docs.

See this for reference: https://meta.trac.wordpress.org/ticket/197

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the current parameter-documentation parsing behavior and the linked WordPress reference ticket. Determine how list-form Markdown is represented and identify the relevant tests or entry points; done means Markdown lists in parameter docs are parsed correctly without regressing existing documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.