[wp-trac] [WordPress Trac] #37321: Improve documentation of user_can_richedit()
WordPress Trac
noreply at wordpress.org
Sun Jul 10 12:32:00 UTC 2016
#37321: Improve documentation of user_can_richedit()
--------------------------+----------------------------------------
Reporter: swissspidy | Owner:
Type: defect (bug) | Status: new
Priority: normal | Milestone: Awaiting Review
Component: General | Version:
Severity: normal | Keywords: needs-patch good-first-bug
Focuses: |
--------------------------+----------------------------------------
The whole docblock for `user_can_richedit()` needs a bit of an overhaul.
Same goes for the `user_can_richedit` filter.
There are some typos, like ''WYSIWIG'' should be ''WYSIWYG'' and ''users
browser'' should be ''user's browser''.
The return value needs to be documented properly, as well as the global
variables referenced.
Also, the wording can be improved a bit. For example, ''Whether the user
can access the visual editor.'' sounds better than ''Whether the user
should have a WYSIWIG editor.''
See https://core.trac.wordpress.org/browser/trunk/src/wp-includes/general-
template.php?rev=38029#L2875
--
Ticket URL: <https://core.trac.wordpress.org/ticket/37321>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list