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

Add a notice that the Fake Timers API doc is incomplete #2570

Merged
merged 1 commit into from
Nov 5, 2023

Conversation

fatso83
Copy link
Contributor

@fatso83 fatso83 commented Nov 5, 2023

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

  1. Check out this branch
  2. npm install

Checklist for author

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

Copy link

codecov bot commented Nov 5, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (93db3ef) 96.02% compared to head (bff296c) 96.02%.

❗ Current head bff296c differs from pull request most recent head 575d90d. Consider uploading reports for the commit 575d90d to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2570   +/-   ##
=======================================
  Coverage   96.02%   96.02%           
=======================================
  Files          40       40           
  Lines        1912     1912           
=======================================
  Hits         1836     1836           
  Misses         76       76           
Flag Coverage Δ
unit 96.02% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@fatso83 fatso83 merged commit 6c9f5c2 into main Nov 5, 2023
10 checks passed
@fatso83 fatso83 deleted the fake-timers-ref-comment branch November 5, 2023 20:21
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.

None yet

1 participant