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 "testing your code" section #1383

Merged
merged 3 commits into from
Mar 25, 2023

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

This PR introduces a new section to the Parameters docs. This section features examples and recommendations on how to test end users' code that uses the utility. It shows how to test the code at different levels ranging from mocking the module from the imports, to using spies, to using a 3rd party library for a more fully featured mock API.

Once merged this PR closes #1321.

How to verify this change

See screenshots below that show most/all the parts of the new section:

Screenshot 2023-03-25 at 20 52 11

Screenshot 2023-03-25 at 20 52 35

Screenshot 2023-03-25 at 20 52 23

Screenshot 2023-03-25 at 20 51 55

Related issues, RFCs

Issue number: #1321

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

Is it a breaking change?: NO

  • 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.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi self-assigned this Mar 25, 2023
@dreamorosi dreamorosi linked an issue Mar 25, 2023 that may be closed by this pull request
1 task
@pull-request-size pull-request-size bot added the size/L PRs between 100-499 LOC label Mar 25, 2023
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 25, 2023
@dreamorosi dreamorosi merged commit 72e7fe2 into main Mar 25, 2023
@dreamorosi dreamorosi deleted the 1321-docs-add-testing-your-code-section branch March 25, 2023 22:20
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 size/L PRs between 100-499 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: add testing your code section
1 participant