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

Update Checkbox label prop documentation #2194

Merged
merged 7 commits into from
Jan 5, 2024

Conversation

ncovercash
Copy link
Member

@ncovercash ncovercash commented Jan 4, 2024

The label prop accepts a node in the prop-types and the usage concurs; this brings the README in line with this.

The prop accepts a node in the prop-types and [the usage concurs](https://github.com/folio-org/stripes-components/blob/master/lib/Checkbox/Checkbox.js#L157); this brings the README in line with this.
Copy link

github-actions bot commented Jan 4, 2024

Jest Unit Test Statistics

0 tests  ±0   0 ✔️ ±0   0s ⏱️ ±0s
0 suites ±0   0 💤 ±0 
0 files   ±0   0 ±0 

Results for commit c5b95e3. ± Comparison against base commit 2237df6.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Jan 4, 2024

BigTest Unit Test Statistics

       1 files  ±0         1 suites  ±0   11s ⏱️ ±0s
1 416 tests ±0  1 395 ✔️ ±0  21 💤 ±0  0 ±0 
1 419 runs  ±0  1 398 ✔️ ±0  21 💤 ±0  0 ±0 

Results for commit c5b95e3. ± Comparison against base commit 2237df6.

♻️ This comment has been updated with latest results.

zburke
zburke previously requested changes Jan 4, 2024
Copy link
Member

@zburke zburke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

label: PropTypes.node,

So in fact this should be plain node, not string, node.

@ncovercash
Copy link
Member Author

label: PropTypes.node,

So in fact this should be plain node, not string, node.

PropTypes.node includes string (docs, source), just as ReactNode contains string

Happy to add it if it makes it more readable, though!

@ncovercash ncovercash requested a review from zburke January 4, 2024 22:42
Copy link

sonarcloud bot commented Jan 5, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@zburke zburke dismissed their stale review January 5, 2024 16:26

PropTypes.node includes string you dummy

@ncovercash ncovercash merged commit 516877c into master Jan 5, 2024
6 checks passed
@ncovercash ncovercash deleted the fix-checkbox-label-prop-readme branch January 5, 2024 16:32
github-actions bot pushed a commit that referenced this pull request Jan 5, 2024
The prop accepts a node in the prop-types and [the usage concurs](https://github.com/folio-org/stripes-components/blob/master/lib/Checkbox/Checkbox.js#L157); this brings the README in line with this.

Co-authored-by: John Coburn <jcoburn@ebsco.com>
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

Successfully merging this pull request may close these issues.

5 participants