-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
Let's formalize how to write JSDoc. I can tell who is writing the documentation, which should not be the case. So, we need some rules.
Here are some tentative rules that I am proposing:
- Don't use pronouns
- Use complete sentences (the JSDoc is going to our actual API docs)
- End param descriptions with a period
- Encapsulate variables and functions with ticks
- Use correct punctuation in JS comments in examples
- Place JSDoc immediately above the function definition (helpers and imports go above)
Ultimately, we need to finalize this list and probably place it in a CONTRIBUTING.md or something.
Metadata
Metadata
Assignees
Labels
No labels