Opened 11 days ago
Last modified 8 days ago
#42505 new task (blessed)
Docblock improvements for 5.0
| Reported by: |
|
Owned by: | |
|---|---|---|---|
| Milestone: | 5.0 | Priority: | normal |
| Severity: | normal | Version: | |
| Component: | General | Keywords: | |
| Focuses: | docs | Cc: |
Change History (3)
#1
@johnbillion
11 days ago
#2
@johnbillion
11 days ago
In 42151:
#3
@SergeyBiryukov
8 days ago
@afercia in #42530:
- ...seems to me all the new functions introduced in [41630] miss a @since notation in their docblocks.
- Additional note about documentation standards: many multiline inline comments introduced in [41630] use a double asterisk, e.g.:
/** * If the selection is on a shortcode with Live View, TinyMCE creates a bogus markup, * which we have to account for. */- Note: one more coding standard that isn't met across [41630]: Declaring Variables With var
- Each function should begin with a single comma-delimited var statement that declares any local variables necessary
Note: See
TracTickets for help on using
tickets.
In 42143: