docs(commons): refresh API docs & README #2452
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 tasks
boring-cyborg
bot
added
commons
pull-request-size
bot
added
the
size/XL
am29d
approved these changes
May 2, 2024
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Changes
This PR introduces updates to the API docs & README file for the
commonsutility.The main focus of the changes is to document every function/method/type in a consistent and informative way so that the API docs are populated with an even level of details.
Likewise, when it comes to the README file of the utility, I have removed a lot of the fluff and kept actionable and useful info to get a high level view of the package specifically, and then about the project after that.
The rationale behind this change is that the README file, which is used as "cover page" for the utility in the API docs and on npmjs.com, should give a quick overview of what the package is about first and foremost.
Issue number: #2377
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.