JSDoc: wp-admin/js/user-suggest.js

[timhavinga]

Add documentation to the user-select.js file.

[timhavinga]

Two questions remain:

• I added an @see in the documentation to refer to the PHP function that handles the AJAX call performed in this script. Is this the preferred way to document this?
• The input field has optional data-attributes. How to document these?

[atimmer]

In 42708:

Docs: Improve JSDoc for wp-admin/js/user-suggest.js.

Props timhavinga.
Fixes #43270.

[atimmer]

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.

[timhavinga]

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.

[atimmer]

In 42714:

Docs: Improve JSDoc for wp-admin/js/user-suggest.js.

Amend r42708 by fixing the 80 character wrap around.

Props timhavinga.
See #43270.

[atimmer]

Thank you, I've fixed this in my last commit.