Add a notice that the Fake Timers API doc is incomplete #2570
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
This is basically linking to the original Fake Timers
project as an excuse for not keeping the documented API
in sync.
This is a case where the community TypeScript effort at
DefinitelyTyped is doing a much better job than us, as
they simply import the fake-timers types in the Sinon definitions.
How to verify - mandatory
npm install
Checklist for author
npm run lint
passes