mui / mui/material-ui

[docs] FormControl's API page doesn't show `label` as required

Open
#32,161 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

component: FormControl docs scope: text field
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

The docs do not show label as required, the typing seems fine but there should be a required asterisk next to it on this page https://mui.com/api/form-control-label/#main-content

Originally posted by @CWSites in https://github.com/mui/material-ui/issues/29301#issuecomment-1079403582

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the FormControlLabel API page linked in the issue and inspect the documentation source that generates its props table. Update the label entry so the page marks it as required, then verify the required asterisk appears on the rendered API page.

Written by the indexing model from the issue text.

Assessment

Tech stack
react
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.