[docs] Add Component name section to API docs #20434
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
generateName() function adds the "Component Name" entry to a component's .md file. If the component does not have styling available there will be no entry. Style sheet name has been removed from generateProps as it is redundant.
Added function styleNameError() to throw an error when the component is missing a style name. The same error is thrown in the recently added generateName() function, so the error was consolidated to avoid DRY.
Details of bundle changes.Comparing: a2b2463...9e4ead4 Details of page changes
|
oliviertassinari
changed the title
oliviertassinari
changed the title
oliviertassinari
approved these changes
Apr 5, 2020
eps1lon
previously requested changes
Apr 6, 2020
| @@ -344,7 +363,7 @@ function generateClasses(reactAPI) { | |||
| } | |||
|
|
|||
| if (!reactAPI.styles.name) { | |||
| throw new Error(`Missing styles name on ${reactAPI.name} component`); | |||
| styleNameError(reactAPI.name); | |||
There was a problem hiding this comment.
Why do we need this indirection? Be aware that this adds another line to the stack trace.
There was a problem hiding this comment.
Good point. The generateClasses() and generateName() functions both throw the same custom error, and I wasn't sure on the preference for avoiding repetition, so I wrapped it in a function.
oliviertassinari
force-pushed
the
pr17245
branch
from
e1d9154
to
0a5cc0d
Compare
oliviertassinari
force-pushed
the
pr17245
branch
from
0a5cc0d
to
9e4ead4
Compare
|
@Josh-Weston It's a great first pull request on Material-UI 👌🏻. Thank you for working on it! |
This was referenced Apr 13, 2020
This was referenced Apr 21, 2020
This was referenced May 4, 2020
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.
Fixes #17245
generateName() function added to generateMarkdonw.js to create "Component Name" entry in each component's .md file. If the component does not have styling available there will be no entry. "Style sheet" name line has been removed from generateProps() as it is now redundant. Markdown files updated and reviewed. Added function styleNameError() to throw an error when the component is missing a style name. The same error is thrown in the recently added generateName() function, so the error was consolidated to avoid DRY.