Skip to content
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 17 commits into from
Mar 16, 2023
Merged

docs(parameters): add typedoc api docs #1283

merged 17 commits into from
Mar 16, 2023

Conversation

dreamorosi
Copy link
Contributor

@dreamorosi dreamorosi commented Feb 9, 2023

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

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding changes to the examples
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published
  • The PR title follows the conventional commit semantics

Breaking change checklist

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dreamorosi dreamorosi linked an issue Feb 9, 2023 that may be closed by this pull request
@pull-request-size pull-request-size bot added the size/XS PR between 0-9 LOC label Feb 9, 2023
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 9, 2023
@dreamorosi dreamorosi self-assigned this Feb 10, 2023
@dreamorosi dreamorosi added the parameters This item relates to the Parameters Utility label Feb 10, 2023
@dreamorosi dreamorosi force-pushed the 1043-docs-create-api-docs branch from c04c0d7 to 97133f5 Compare February 21, 2023 16:02
@pull-request-size 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 dreamorosi force-pushed the 1043-docs-create-api-docs branch from 57218c1 to 268ea1e Compare February 22, 2023 17:13
@pull-request-size 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 dreamorosi force-pushed the 1043-docs-create-api-docs branch from 1e5c39a to 452ca89 Compare February 23, 2023 14:39
@pull-request-size 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
@dreamorosi dreamorosi marked this pull request as ready for review February 24, 2023 13:48
@dreamorosi dreamorosi added the do-not-merge This item should not be merged label Feb 24, 2023
@am29d am29d self-requested a review March 14, 2023 10:44
@dreamorosi
Copy link
Contributor Author

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.

@dreamorosi dreamorosi assigned am29d and unassigned dreamorosi Mar 14, 2023
@dreamorosi dreamorosi removed the request for review from am29d March 14, 2023 11:49
@am29d am29d assigned dreamorosi and unassigned am29d Mar 16, 2023
@am29d am29d self-requested a review March 16, 2023 10:45
@am29d am29d self-assigned this Mar 16, 2023
@am29d am29d removed their request for review March 16, 2023 11:09
@am29d am29d self-requested a review March 16, 2023 12:49
@am29d am29d merged commit 8a47e76 into main Mar 16, 2023
@am29d am29d deleted the 1043-docs-create-api-docs branch March 16, 2023 12:50
@dreamorosi dreamorosi removed the do-not-merge This item should not be merged label 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: create API docs
2 participants