-
Notifications
You must be signed in to change notification settings - Fork 146
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
docs(parameters): add typedoc api docs #1283
Merged
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
Closed
github-actions
bot
added
the
documentation
Improvements or additions to documentation
label
Feb 9, 2023
13 tasks
dreamorosi
force-pushed
the
1043-docs-create-api-docs
branch
from
February 21, 2023 16:02
c04c0d7
to
97133f5
Compare
pull-request-size
bot
added
size/L
PRs between 100-499 LOC
and removed
size/XS
PR between 0-9 LOC
labels
Feb 21, 2023
dreamorosi
force-pushed
the
1043-docs-create-api-docs
branch
from
February 22, 2023 17:13
57218c1
to
268ea1e
Compare
pull-request-size
bot
added
size/XL
PRs between 500-999 LOC, often PRs that grown with feedback
and removed
size/L
PRs between 100-499 LOC
labels
Feb 22, 2023
dreamorosi
force-pushed
the
1043-docs-create-api-docs
branch
from
February 23, 2023 14:39
1e5c39a
to
452ca89
Compare
pull-request-size
bot
added
size/XXL
PRs with 1K+ LOC, largely documentation related
and removed
size/XL
PRs between 500-999 LOC, often PRs that grown with feedback
labels
Feb 23, 2023
Assigning this to you (@am29d) so that you can add commits directly in this PR to address the alpha comments. Feel free to also fix other things you might encounter. After done, you can either ask for a review or merge it directly. |
am29d
approved these changes
Mar 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
parameters
This item relates to the Parameters Utility
size/XXL
PRs with 1K+ LOC, largely documentation related
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.
Description of your changes
This PR introduces docstrings for the new Parameters utility which are then converted with
typedoc
to the API reference published alongside the docs. In line with the other utilities I have documented all public methods more extensively and written long-form intros/reference for each main class & function. The public methods also have example usages which should help users, while the private/protected methods are documented only for the maintainers' sake.Once merged, this PR will close #1043.
How to verify this change
To help with the review I have published the api docs to this url so that you can see them in your browser.
Note that once the PR is merged the URL will stop working and the docs will be available on the main docs website.
Related issues, RFCs
Issue number: #1043
PR status
Is this ready for review?: YES
Is it a breaking change?: NO
Checklist
Breaking change checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.