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: add links to clarify API #2137

Merged
merged 2 commits into from Oct 11, 2019

Conversation

peterjgrainger
Copy link
Contributor

@peterjgrainger peterjgrainger commented Oct 9, 2019

Purpose (TL;DR) - mandatory

Fix issue #2070 by adding links to Stubs and Spies documentation and clarifying how Fakes are linked to Stubs and Spies

How to verify

  1. Check out this branch
  2. Open the markdown file

Checklist for author

  • npm run lint passes
  • References to standard library functions are cached.

Copy link
Member

@mroderick mroderick left a comment

Choose a reason for hiding this comment

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

Thank you for your pull request. There are a few inaccuracies, I've made some suggested changes that should be easy to import.

docs/release-source/release/fakes.md Outdated Show resolved Hide resolved
docs/release-source/release/fakes.md Outdated Show resolved Hide resolved
docs/release-source/release/fakes.md Outdated Show resolved Hide resolved
docs/release-source/release/fakes.md Outdated Show resolved Hide resolved
docs/release-source/release/fakes.md Outdated Show resolved Hide resolved
docs/release-source/release/fakes.md Outdated Show resolved Hide resolved
docs/release-source/release/fakes.md Outdated Show resolved Hide resolved
Co-Authored-By: Morgan Roderick <20321+mroderick@users.noreply.github.com>
@peterjgrainger
Copy link
Contributor Author

peterjgrainger commented Oct 10, 2019

Thanks for the review @mroderick. On second look I think you are right. The methods have the same API as with stubs but it's confusing to add that info here.

Agree with your suggestions

@mroderick mroderick merged commit ba2e0ec into sinonjs:master Oct 11, 2019
@mroderick
Copy link
Member

Perfect 👍

@mroderick
Copy link
Member

Because of how the documentation works in this project, the changes won't be visible on the site until the next release (which won't be that long).

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

2 participants