Adds support for marking components as internal#1488
Open
valadas wants to merge 1 commit intoDNNCommunity:developfrom
Open
Adds support for marking components as internal#1488valadas wants to merge 1 commit intoDNNCommunity:developfrom
valadas wants to merge 1 commit intoDNNCommunity:developfrom
Conversation
We sometimes need to create components that we don't want consumers to use directly: - The component is an example - The component is only used internally as part of a larger complex component With this change we can exclude such components with @internal jsdoc attribute which will skip it from types and vscode docs to reduce their discoverability.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 sometimes need to create components that we don't want consumers to use directly:
With this change we can exclude such components with
@internaljsdoc attribute which will skip it from types and vscode docs to reduce their discoverability.