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

Documentation for assertion options for the sandbox #2564

Merged
merged 3 commits into from
Oct 28, 2023

Conversation

fatso83
Copy link
Contributor

@fatso83 fatso83 commented Oct 28, 2023

  • doc: improve JSDocs
  • docs: improve public docs for sandbox
  • Add example on adding assertOptions to the sandbox

- move some important info up where it is more visible
- remove some bits no longer relevant (sinon.config)
  and replace with its modern (post Sinon 1) equivalent
@codecov
Copy link

codecov bot commented Oct 28, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f7d180c) 96.05% compared to head (0e8f168) 96.05%.

❗ Current head 0e8f168 differs from pull request most recent head de7f7e0. Consider uploading reports for the commit de7f7e0 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2564   +/-   ##
=======================================
  Coverage   96.05%   96.05%           
=======================================
  Files          41       41           
  Lines        1928     1928           
=======================================
  Hits         1852     1852           
  Misses         76       76           
Flag Coverage Δ
unit 96.05% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
lib/sinon/create-sandbox.js 100.00% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@fatso83 fatso83 changed the title Add documentation for assertion options for the sandbox (plus additional improvements) Documentation for assertion options for the sandbox Oct 28, 2023
@fatso83 fatso83 merged commit b5fc367 into sinonjs:main Oct 28, 2023
7 checks passed
@fatso83 fatso83 deleted the update-docs-with-assertion-limit branch October 28, 2023 20:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant