Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a lint rule to require at least some docs if jsdoc is defined #17509

Open
turt2live opened this issue Jun 1, 2021 · 2 comments
Open

Add a lint rule to require at least some docs if jsdoc is defined #17509

turt2live opened this issue Jun 1, 2021 · 2 comments
Labels
A-Documentation Hacktoberfest Issues which are suitable for Hacktoberfest PRs: https://hacktoberfest.digitalocean.com/ Help Wanted Extra attention is needed O-Uncommon Most users are unlikely to come across this or unexpected workflow S-Minor Impairs non-critical functionality or suitable workarounds exist T-Task Tasks for the team like planning

Comments

@turt2live
Copy link
Member

The following is not helpful, for example:


/**
 * @param {string} roomId
 * @param {string} userId
 * @param {string} reason Optional.
 * @param {module:client.callback} callback Optional.
 * @return {Promise} Resolves: TODO
 * @return {module:http-api.MatrixError} Rejects: with an error response.
 */

This repeated a number of times through our code.

@Palid Palid added A-Developer-Experience T-Task Tasks for the team like planning O-Uncommon Most users are unlikely to come across this or unexpected workflow S-Minor Impairs non-critical functionality or suitable workarounds exist labels Sep 14, 2021
@Palid Palid added this to In discussion in Developer experience via automation Sep 14, 2021
@Palid Palid moved this from In discussion to Ready to develop in Developer experience Sep 14, 2021
@richvdh
Copy link
Member

richvdh commented Nov 14, 2022

The following is not helpful, for example:

Is this in react-sdk/element-web or js-sdk?

If the former, I don't think they attempt to publish jsdoc so I agree it's not helpful (but then I'd argue that the solution is not to require more jsdoc).

If js-sdk, then prior to matrix-org/matrix-js-sdk#2869, this was better than nothing, because it meant at least the types and param names made it into the jsdoc. That stuff is populated automatically now, so yes it's not helpful. Still, I'm not in a rush to rip it all out.

@turt2live
Copy link
Member Author

This was in the js-sdk (contet clue being the module:http-api.MatrixError weirdness)

@Johennes Johennes added Help Wanted Extra attention is needed Hacktoberfest Issues which are suitable for Hacktoberfest PRs: https://hacktoberfest.digitalocean.com/ labels Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Documentation Hacktoberfest Issues which are suitable for Hacktoberfest PRs: https://hacktoberfest.digitalocean.com/ Help Wanted Extra attention is needed O-Uncommon Most users are unlikely to come across this or unexpected workflow S-Minor Impairs non-critical functionality or suitable workarounds exist T-Task Tasks for the team like planning
Projects
No open projects
Developer experience
Ready to develop
Development

No branches or pull requests

4 participants