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
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
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
Codecov Report
@@ 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
previously approved these changes
Feb 26, 2022
prisis
previously approved these changes
Mar 1, 2022
ST-DDT
force-pushed
the
docs/options-param-docs
branch
from
March 1, 2022 19:24
4335bfe
to
e701672
Compare
Updated |
ST-DDT
force-pushed
the
docs/options-param-docs
branch
from
March 1, 2022 19:27
e701672
to
a741d1f
Compare
ST-DDT
removed
the
do NOT merge yet
Do not merge this PR into the target branch yet
label
Mar 1, 2022
prisis
previously approved these changes
Mar 1, 2022
prisis
reviewed
Mar 1, 2022
ST-DDT
force-pushed
the
docs/options-param-docs
branch
from
March 1, 2022 20:18
73f9db1
to
ebc59ad
Compare
prisis
approved these changes
Mar 2, 2022
griest024
approved these changes
Mar 2, 2022
demipel8
pushed a commit
to demipel8/faker
that referenced
this pull request
Mar 11, 2022
ST-DDT
modified the milestones:
v6 - Non-Breaking Changes,
v6.0 - Ensure Project Foundation
Apr 19, 2022
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.
Example
Note
Only merge after #564
Currently this does not work for union parameters e.g.
number | { ...}
TypeStrong/typedoc#1876