Skip to content
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

Feat: Add ability to hide props from the docs #161

Open
pgmanutd opened this issue Feb 23, 2021 · 1 comment
Open

Feat: Add ability to hide props from the docs #161

pgmanutd opened this issue Feb 23, 2021 · 1 comment

Comments

@pgmanutd
Copy link
Contributor

Right now there is no official way to hide props from the docs. Probably we can use something like @internal or @private to hide them.

export interface Props {
  /** Some description */
  id?: string;
  /**
   * @internal
   * Some description
   */
  privateId?: string
}
@pgmanutd pgmanutd changed the title Feat: Add ability to hide props from docs Feat: Add ability to hide props from the docs Feb 23, 2021
@jenniesyip
Copy link

Reminds me of: http://sassdoc.com/annotations/#access

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants