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: document options params in api docs #570

Merged
merged 3 commits into from Mar 3, 2022
Merged

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Feb 26, 2022

Example

grafik

Note

Only merge after #564
Currently this does not work for union parameters e.g. number | { ...} TypeStrong/typedoc#1876

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation do NOT merge yet Do not merge this PR into the target branch yet labels Feb 26, 2022
@ST-DDT ST-DDT requested a review from a team as a code owner February 26, 2022 11:33
@ST-DDT ST-DDT self-assigned this Feb 26, 2022
@codecov
Copy link

codecov bot commented Feb 26, 2022

Codecov Report

Merging #570 (1c5c556) into main (60d3cc5) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #570   +/-   ##
=======================================
  Coverage   99.34%   99.34%           
=======================================
  Files        1920     1920           
  Lines      176424   176424           
  Branches      904      904           
=======================================
  Hits       175267   175267           
  Misses       1101     1101           
  Partials       56       56           

Shinigami92
Shinigami92 previously approved these changes Feb 26, 2022
@Shinigami92 Shinigami92 requested a review from a team February 26, 2022 14:58
prisis
prisis previously approved these changes Mar 1, 2022
Base automatically changed from docs/generate-docs-for-injected-methods to main March 1, 2022 18:55
@Shinigami92 Shinigami92 added the needs rebase There is a merge conflict label Mar 1, 2022
@ST-DDT ST-DDT dismissed stale reviews from prisis and Shinigami92 via e701672 March 1, 2022 19:24
@ST-DDT ST-DDT requested a review from a team March 1, 2022 19:24
@ST-DDT
Copy link
Member Author

ST-DDT commented Mar 1, 2022

Updated

@ST-DDT ST-DDT removed the needs rebase There is a merge conflict label Mar 1, 2022
@ST-DDT ST-DDT removed the do NOT merge yet Do not merge this PR into the target branch yet label Mar 1, 2022
prisis
prisis previously approved these changes Mar 1, 2022
scripts/apidoc/signature.ts Outdated Show resolved Hide resolved
@ST-DDT ST-DDT merged commit 29b61cd into main Mar 3, 2022
@ST-DDT ST-DDT deleted the docs/options-param-docs branch March 3, 2022 00:10
demipel8 pushed a commit to demipel8/faker that referenced this pull request Mar 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants