chore: Fixes core documenter snapshot #88
Conversation
| "analyticsTag": undefined, | ||
| "defaultValue": undefined, | ||
| "deprecatedTag": undefined, | ||
| "description": "Defines the minimum allowed width of the chart plot. When the parent container is smaller the |
There was a problem hiding this comment.
Can be fixed separately, but there is a little typo in this description: the word "than" is missing between "smaller" and "the". In the previous description it is correct.
Besides, to be even more precise, instead of "smaller" we could say "narrower" or "shorter" depending on the case.
| "analyticsTag": undefined, | ||
| "defaultValue": undefined, | ||
| "deprecatedTag": undefined, | ||
| "description": "Use Cloudscape keyboard navigation, \`true\` by default.", |
There was a problem hiding this comment.
Could defaultValue be true instead of having it indicated in the description?
| "defaultValue": undefined, | ||
| "deprecatedTag": undefined, | ||
| "description": "Controls the placement of the vertical axis title. | ||
| When set to "side", displays the title along the axis line.", |
There was a problem hiding this comment.
There are unescaped double quotes here inside a string delimited in double quotes. Will this work as expected?
There was a problem hiding this comment.
Yes, it should. I think this is just the format the snapshot uses. We use double quotes in existing api docs, no problem with that.
| export { CoreChartProps }; | ||
|
|
||
| function CoreChart(props: CoreChartProps) { | ||
| function CoreChart({ keyboardNavigation = true, ...props }: CoreChartProps) { |
There was a problem hiding this comment.
Why is the keyboardNavigation handled separately from the rest of the props in the function?
There was a problem hiding this comment.
This is to assign the default value. When done in the index file - this can be parsed by the documenter. You can check the documenter snapshot - now the default value for keyboardNavigation is defined.
3 participants
Description
Depends on cloudscape-design/documenter#85
How has this been tested?
Review checklist
The following items are to be evaluated by the author(s) and the reviewer(s).
Correctness
CONTRIBUTING.md.CONTRIBUTING.md.Security
checkSafeUrlfunction.Testing
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.