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

Matcher documentation #142

Merged
merged 3 commits into from
Oct 17, 2019
Merged

Matcher documentation #142

merged 3 commits into from
Oct 17, 2019

Conversation

mantoni
Copy link
Member

@mantoni mantoni commented Oct 16, 2019

Purpose (TL;DR) - mandatory

Some quick and easy documentation improvements

  • We've been lying about dependencies and IE6 support for some time now.
  • The matchers documentation was missing the pre defined matchers. I've copied the relevant section from the Sinon docs.

@codecov
Copy link

codecov bot commented Oct 16, 2019

Codecov Report

Merging #142 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           master   #142   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          25     25           
  Lines         498    498           
=====================================
  Hits          498    498
Flag Coverage Δ
#unit 100% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f292eb3...6470cd9. Read the comment docs.


Requires the value to strictly equal `ref`.

#### `sinon.match.typeOf(type)`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can further improve samsam to support all the types that type-detect can detect: https://github.com/chaijs/type-detect#readme

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that would be very easy to do. 👍

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder why we use sinon.match and not samsam.match on all of these. Seems super weird when reading the docs under the assumption that this is a standalone library.

@mroderick mroderick merged commit 806632f into master Oct 17, 2019
@mroderick mroderick deleted the matcher-documentation branch October 17, 2019 16:55
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.

None yet

3 participants