Internal: use multiline comments to enable flow docs #2383
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
✅ Deploy Preview for gestalt ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
| @@ -18,11 +18,19 @@ const buildSourceLinkUrl = (componentName) => | |||
|
|
|||
| type Props = {| | |||
| badge?: 'pilot' | 'deprecated', | |||
| // DEPRECATED: Use `children` instead of `defaultCode` | |||
| /** | |||
| * @deprecated : Use `children` instead of `defaultCode` | |||
There was a problem hiding this comment.
Since flow out of the box doesn't yet support deprecated types, we use JSDoc comments instead:
- Feature request - marking types as deprecated. facebook/flow#4646
- https://jsdoc.app/tags-deprecated.html
Note that in TypeScript, the JSDoc format is also recommended: microsoft/TypeScript#390
dangerismycat
approved these changes
Sep 12, 2022
| @@ -18,11 +18,19 @@ const buildSourceLinkUrl = (componentName) => | |||
|
|
|||
| type Props = {| | |||
| badge?: 'pilot' | 'deprecated', | |||
| // DEPRECATED: Use `children` instead of `defaultCode` | |||
| /** | |||
| * @deprecated : Use `children` instead of `defaultCode` | |||
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.
Summary
What changed?
Use multiline comments to enable flow docs
Why?
Makes the comments visible to where the props are being used, not just where they are defined.