[core] Refactor how we ignore default values in docs #22355
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
|
No bundle size changes comparing afac5cd...5fed30d |
oliviertassinari
approved these changes
Aug 25, 2020
mbrookes
reviewed
Aug 25, 2020
Co-authored-by: Matt <github@nospam.33m.co>
Probably moved around over time until the original intention got lost. |
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.
We currently strip default values from the API docs if their source including the markup we add exceeds 180 characters. I don't think this is intended. It seems like this is to prevent breaking the table layout (or generally only to keep readable default values) in which case we should only look at the source without added markup.
This doesn't affect the generated docs but the clarification is important for default values in JSDOC.