chore(docs): clean up miscellaneous component documentation#1992
chore(docs): clean up miscellaneous component documentation#1992dvdzkwsk merged 5 commits intomicrosoft:masterfrom dvdzkwsk:chore/doc-fixes
Conversation
dvdzkwsk
requested review from
kuzhelov,
layershifter,
levithomason,
miroslavstastny and
mnajdova
as code owners
There was a problem hiding this comment.
Minor consistency change: "may" and "can" were used interchangeably, so I just picked one.
There was a problem hiding this comment.
We should standardize on capitalization conventions across all components, but for now I think it's sufficient to ensure they are consistent within a single component. In this case, most were already lowercase.
There was a problem hiding this comment.
Since this is a string, it's not necessarily in seconds.
There was a problem hiding this comment.
Consistency: Accordion uses the word expanded to describe its panels' open states, and that term is also already used in describing other props.
There was a problem hiding this comment.
Most components don't reiterate the name of the property in the doc string, which I think is a good thing. I've removed it from Animation to make it consistent with the rest of the components.
There was a problem hiding this comment.
I believe checkbox is meant by item here.
Min words is listed as 5, but the the assertion contradicts this by asserting that words is _greater_ than min words.
Codecov Report
@@ Coverage Diff @@
## master #1992 +/- ##
=======================================
Coverage 77.02% 77.02%
=======================================
Files 158 158
Lines 5459 5459
Branches 1581 1597 +16
=======================================
Hits 4205 4205
Misses 1241 1241
Partials 13 13
Continue to review full report at Codecov.
|
Generated by 🚫 dangerJS |
|
DangerJS improperly flagging a whitespace fix in the Changelog. Ignoring. |
3 participants
As I've been working on the new Stardust docs I've encountered various typos, grammatical errors, and tense/wording inconsistencies. Since the new docs are using the same exact schemas the current ones do, I figured I'd share the changes sooner than later :).
For wording changes, I tried to keep as true to the original intent as possible while cleaning up the language a bit. If I've gone astray with any of the changes, please let me know!