documentation should indicate expected return values
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 48.7k
- Forks
- 2.8k
- PR merge metrics
- No merged PRs in 30d
Description
Hi @iamkun! First off, thank you and all contributors for this library!
I wanted to point out an issue with the documentation, which I'm happy to work on incrementally over the next few weeks. Take, for example, the docs for the Timezone plugin:
I'd like to add comments to the documentation that clarify what the expected return values should be.
Thoughts or suggestions are welcome and encouraged!
Will assign to myself for the time being, but please let me know if you have any concerns of course.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Timezone plugin documentation linked in the issue and review its examples and API descriptions. Identify the documented operations whose expected return values are unclear, then add comments or explanations that make those values explicit. Done means the relevant examples clearly state what they return.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100