[internal] API docs generator including props of unstyled components
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 99.1k
- Forks
- 32.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 106
Description
I've encountered an issue while working on the Popper component (https://github.com/mui-org/material-ui/pull/29488#discussion_r743640362).
Popper uses PopperUnstyled internally but has a different set of props. Specifically, type PopperProps = Omit<PopperUnstyledProps, 'direction'>.
However, when building API documentation for Popper, the direction prop appears on the generated page. The docs generator should take into consideration the real shape of PopperProps.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue concerns the API docs generator and the Popper component; start by tracing how PopperProps is resolved when generating Popper's API page. Compare the generated props with the Omit<PopperUnstyledProps, 'direction'> definition, then verify that direction is absent while valid Popper props remain.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100