Skip to content

Conversation

@malev
Copy link

@malev malev commented Nov 9, 2017

Purpose (TL;DR) - mandatory

Remove a duplicated line from the documentation

Background (Problem in detail) - optional

If you visit the [http://sinonjs.org/releases/v4.1.2/stubs/](stubs documentation) you can see that stub.callsArgAsync(index); is duplicated.

How to verify - mandatory

  1. Open docs/release-source/release/stubs.md and verify that stub.callsArgAsync(index); appears only once.

Checklist for author

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

@mroderick
Copy link
Member

Good find! There is definitely something weird going on in this section of the documentation.

The following sentence is also duplicated:

Same as their corresponding non-Async counterparts, but with callback being deferred (executed not immediately but after short timeout and in another "thread")

I think we need to do more for this section, than just delete the duplication. Perhaps a level 3 header about async variations using the sentence above.

Please note that it is not enough to only change docs/release-source when documenting existing functionality, you will also need to go through the documentation in docs/_releases and update that.

Would you be up for making those changes?

@stale
Copy link

stale bot commented Jan 13, 2018

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Jan 13, 2018
@stale stale bot closed this Jan 20, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants