Improve default content function

Open
#40 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Locate expand_content() and its default output path, then compare how it formats functions with the expected needs of classes and hooks. Check the handling of the Arguments heading and the proposed wpfuncref_content() name. Done means the default content is appropriate for these element types, omits empty sections, and has an agreed function name.

Written by the indexing model from the issue text.

Description

enhancement

While expand_content() can be dropped by developers in favour of a custom output, the default function should still be improved.

It is currently very focused towards how functions look, and not classes and hooks. For instance, the prototype doesn't make a lot of sense of classes or hooks.

The Arguments heading is output regardless of whether there are any argument or not.

The function name itself is also a little too generic - wpfuncref_content() might be better for instance.

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

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.

More from WordPress/phpdoc-parser

All issues in WordPress/phpdoc-parser

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.