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

Improve documentation: async calls (#1286) #1655

Merged
merged 4 commits into from
Jan 16, 2018

Conversation

ifrost
Copy link
Contributor

@ifrost ifrost commented Jan 15, 2018

Purpose (TL;DR) - mandatory

This is to improve documentation of async stub calls - http://sinonjs.org/releases/v4.1.5/stubs/#stubcallsargasyncindex

Background (Problem in detail) - optional

Issue: #1286.
It also fixes duplicated docs mentioned in #1618.
Updated for new and current release.

How to verify - mandatory

  1. Check out this branch
  2. npm install
  3. cd docs
  4. build docs: bundle exec jekyll serve

Copy link
Member

@mantoni mantoni left a comment

Choose a reason for hiding this comment

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

LGTM

@mroderick
Copy link
Member

Thank for your contribution. I only have one comment, which is to reduce the indentation of the bullet lists, as first level bullets in Markdown don't need indenting.

    * not this
* but this

Markdown doesn't require indenting the first level.
@ifrost
Copy link
Contributor Author

ifrost commented Jan 15, 2018

Thank for your contribution. I only have one comment, which is to reduce the indentation of the bullet lists, as first level bullets in Markdown don't need indenting.

Sure thing! Updated.

@mroderick mroderick merged commit acebab9 into sinonjs:master Jan 16, 2018
@mroderick
Copy link
Member

Thank you 👍

franck-romano pushed a commit to franck-romano/sinon that referenced this pull request Oct 1, 2019
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.

4 participants