docs: improve time/base README Examples
#1657
Merged
Conversation
This file contains 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
stdlib-bot
reviewed
Mar 3, 2024
Planeshifter
approved these changes
Mar 3, 2024
There was a problem hiding this comment.
Looks good, thanks!
For future reference, no reason to include the full RFC issue post in the PR description. And ensure your development environment is properly initialized (run make init after installation), as linting should have caught redeclaring the obj variable.
Planeshifter
changed the title
time/base README Examples
Planeshifter
reviewed
Mar 3, 2024
Signed-off-by: Philipp Burckhardt <[email protected]>
bad-in-coding
pushed a commit
to bad-in-coding/stdlib
that referenced
this pull request
Mar 7, 2024
PR-URL: stdlib-js#1657 Resolves: stdlib-js#1653 --------- Signed-off-by: Philipp Burckhardt <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
1 task
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.
Resolves #1653 .
RFC: improve README examples of time/base namespace
Description
This RFC proposes to enhance the README examples for the
time/basenamespace package. The current state of the namespace package READMEs features only minimal examples, which are not sufficiently informative nor do they showcase the functionality of the namespace effectively.Given the project's development and organization have now stabilized, it's an opportune time to revisit these packages and enrich the README with comprehensive examples. These examples will better illustrate how to utilize the contents of the namespace, thereby aiding users in understanding and applying the package's functionalities.
Contributors to this enhancement can follow these steps:
time/basenamespace to identify notable functions and packages.Related Issues
None.
Questions
No questions at this time. I welcome any feedback on the proposed changes to the README examples.
Other
No additional information. The updates are focused on improving documentation through better examples, without altering the functionality of the
time/basenamespace.Checklist
@stdlib-js/reviewers