Skip to:
Content

bbPress.org

Opened 7 years ago

Last modified 5 days ago

#3110 new task (blessed)

Add missing filter documentation

Reported by: johnjamesjacoby's profile johnjamesjacoby Owned by:
Milestone: 2.7 Priority: normal
Severity: normal Version: 2.0
Component: Tools - Code Improvements Keywords: good-first-bug changes-requested needs-docs
Cc: SirLouen

Description

In r6438, I added an easy way to identify which filters are missing documentation blocks.

A search for:

// Filter & return

...currently yields 533 results, all of which represent filters in bbPress that are missing documentation about why someone might want to hook into them.

It would be simply wonderful for some enterprising soul to chug through these and document them. Then we can set bbPress up with one of those fancy auto-documenting filter tools like WordPress has.

Change History (4)

This ticket was mentioned in PR #17 on bbpress/bbPress by @narenin.


2 months ago
#1

  • Keywords has-patch added

@narenin commented on PR #17:


2 months ago
#2

@JJJ @krupal-panchal Could you please review this.

#3 @SirLouen
6 days ago

  • Cc SirLouen added
  • Keywords changes-requested added; needs-docs has-patch removed

The format is not standard according to Hooks documentation.

Check this:
https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#4-hooks-actions-and-filters

There should not be any @return statements, only @param

Also if you have @since in the function, you can take it as a reference.

Last edited 6 days ago by SirLouen (previous) (diff)

#4 @SirLouen
5 days ago

  • Keywords needs-docs added
Note: See TracTickets for help on using tickets.