[Docs] Update fake-server usage & descriptions #2365
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
With the update to support es6 modules, the organization of `nise` module inside of sinon namespace changed. `createFakeServer()` no longer exists but rather `fakeServer` is a property of an imported/required module `sinon` with a singular `create()` method. This is updated on the main page of https://sinonjs.org but not in the detailed API page here. Added additional clarity and important information for usage of parameters. Removed duplication of property descriptions to increase readability.
|
Thank you! Docs are our weakest points and a constant source of guilt 😅 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose (TL;DR) - mandatory
Documentation update to match front page usage in the detailed usage page. The functions described no longer exist but are found through a different path for
sinon.fakeServer.Background & Solution
With the update to support es6 modules, the organization of
nisemodule inside of sinon namespace changed.createFakeServer()no longer exists but ratherfakeServeris a property of an imported/required modulesinonwith a singularcreate()method.This is updated on the main page of https://sinonjs.org but not in the detailed API page
docs/release-source/release/fake-xhr-and-server.md.Added additional clarity and important information for usage of parameters. Removed duplication of property descriptions to increase readability.
How to verify - mandatory