atlassian / atlassian/extract-react-types

Feat: Add ability to hide props from the docs

Open
#161 1 comment 2 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
188
Forks
31
PR merge metrics
No merged PRs in 30d

Description

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.

```ts
export interface Props {
/** Some description */
id?: string;
/**
* @internal
* Some description
*/
privateId?: string
}
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.