#43270 closed defect (bug) (fixed)
JSDoc: wp-admin/js/user-suggest.js
Reported by: | timhavinga | Owned by: | atimmer |
---|---|---|---|
Milestone: | 5.1 | Priority: | normal |
Severity: | normal | Version: | |
Component: | Networks and Sites | Keywords: | |
Focuses: | javascript, docs, multisite | Cc: |
Description
Add documentation to the user-select.js file.
Attachments (1)
Change History (11)
This ticket was mentioned in Slack in #core-js by atimmer. View the logs.
7 years ago
#3
@
7 years ago
- Summary changed from JSDoc: wp-admin/js/user-select.js to JSDoc: wp-admin/js/user-suggest.js
#4
@
7 years ago
- Owner set to atimmer
- Resolution set to fixed
- Status changed from new to closed
In 42708:
#5
follow-up:
↓ 6
@
7 years ago
Thank you for your contribution!
About your questions:
- I've discussed this during the #core-js chat. The takeaway is that because this documentation is mainly for people reading the code, the way you have documented it is the way to go.
- The optional data attributes are fairly specific to this use-case, so I would say that the way you documented it is great. It is human readable and I don't think we need a repeatable way to do this.
I made a one change before committing:
- Reformatted the second doc block to have a clear short description and a longer description.
#6
in reply to:
↑ 5
@
7 years ago
Thank you for the feedback and your kind words!
Replying to atimmer:
I made a one change before committing:
- Reformatted the second doc block to have a clear short description and a longer description.
One small detail: in reformatting, the line endings of the second doc block are no longer at the specified 80 character limit.
Note: See
TracTickets for help on using
tickets.
Two questions remain: