GradientPicker: Auto-generate readme #67250
Conversation
mirka
added
[Type] Developer Documentation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
| @@ -166,44 +166,44 @@ function Component( props: PickerProps< any > ) { | |||
| } | |||
|
|
|||
| /** | |||
| * GradientPicker is a React component that renders a color gradient picker to | |||
| * GradientPicker is a React component that renders a color gradient picker to | |||
There was a problem hiding this comment.
Fixed some formatting here.
| * define a multi step gradient. There's either a _linear_ or a _radial_ type | ||
| * available. | ||
| * | ||
| * ```jsx | ||
| *import { GradientPicker } from '@wordpress/components'; | ||
| *import { useState } from '@wordpress/element'; | ||
| * import { useState } from 'react'; |
There was a problem hiding this comment.
We're switching our docs to import directly from react. (Looks like this was done in bulk for markdown files but not in JSDoc snippets?)
| @@ -58,19 +58,17 @@ type GradientPickerBaseProps = { | |||
| loop?: boolean; | |||
| } & ( | |||
| | { | |||
| // TODO: [#54055] Either this or `aria-labelledby` should be required | |||
There was a problem hiding this comment.
Moving the todo out of JSDoc.
|
Flaky tests detected in 50f9a54. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/11982944783
|
In preparation for #66974
What?
Switch the README for GradientPicker to an auto-generated one (see also #66035).
Testing Instructions
npm run docs:componentsto verify the changes to the README.