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

docs: fix bad Promise usage #2475

Merged
merged 1 commit into from
Oct 14, 2023
Merged

docs: fix bad Promise usage #2475

merged 1 commit into from
Oct 14, 2023

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Oct 12, 2023

Fixes two locations that incorrectly deal with Promises.

  • scripts/apidoc/generate.ts -> Minor miss-usage / no problems
  • scripts/apidoc/signature.ts -> Record<[object Promise], [object Promise]>
Screenshot

grafik

https://next.fakerjs.dev/api/helpers.html#mustache

I couldn't find which lint rule could be used to prevent this in the future 😿 .

@ST-DDT ST-DDT added c: bug Something isn't working c: docs Improvements or additions to documentation p: 2-high Fix main branch labels Oct 12, 2023
@ST-DDT ST-DDT added this to the vAnytime milestone Oct 12, 2023
@ST-DDT ST-DDT requested review from a team October 12, 2023 23:10
@ST-DDT ST-DDT self-assigned this Oct 12, 2023
@codecov
Copy link

codecov bot commented Oct 12, 2023

Codecov Report

Merging #2475 (778f64d) into next (5801c79) will decrease coverage by 0.01%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #2475      +/-   ##
==========================================
- Coverage   99.59%   99.58%   -0.01%     
==========================================
  Files        2823     2823              
  Lines      255516   255516              
  Branches     1105     1104       -1     
==========================================
- Hits       254474   254466       -8     
- Misses       1014     1022       +8     
  Partials       28       28              

see 1 file with indirect coverage changes

@ST-DDT ST-DDT merged commit e228183 into next Oct 14, 2023
23 checks passed
@ST-DDT ST-DDT deleted the docs/fix/async-type-reflection branch October 14, 2023 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: bug Something isn't working c: docs Improvements or additions to documentation p: 2-high Fix main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants