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

Move yieldsAsync* documentation to the first yieldsAsync* #1619

Merged
merged 1 commit into from
Nov 11, 2017

Conversation

malev
Copy link
Contributor

@malev malev commented Nov 9, 2017

Purpose (TL;DR) - mandatory

Move the description for yieldsAsync* methods to the first yieldsAsync* because it makes more sense to be there.

Background (Problem in detail) - optional

If you visit http://sinonjs.org/releases/v4.1.2/stubs/, at first glance it looks like the yieldsAsync* methods lack on documentation.
The generic explanation for all the yieldsAsync* is under yieldsToOnAsync which is the last method on the list
Makes more sense to have the generic documentation under the first yieldsAsync* of the list.

How to verify - mandatory

  1. Check out this branch
  2. npm install

Checklist for author

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

@fatso83
Copy link
Contributor

fatso83 commented Nov 10, 2017

To me, this looks fine, and I don't immediately see the reason to retroactively fix this in the previous versions, since it's not a bug.

@mroderick mroderick merged commit 45c4d57 into sinonjs:master Nov 11, 2017
@mroderick
Copy link
Member

Thank you :)

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.

3 participants