Minor documentation fixes #322
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks, this is awesome! I wrote you some comments to the commit itself but don’t see them in the PR ;-/ |
sapegin
reviewed
Feb 13, 2017
docs/Documenting.md
Outdated
| @@ -1,16 +1,18 @@ | |||
| # Documenting components | |||
|
|
|||
| Styleguidist generates documentation from three sources: | |||
| Styleguidist generates documentation for your components based on the comments in your source code, propTypes declarations and your Readme files. | |||
There was a problem hiding this comment.
Not sure about “your Readme files”. It’s more like a Styleguidist requirement ;-)
docs/Documenting.md
Outdated
| ## PropTypes and component description in the source code | ||
| ## Code comments and propTypes | ||
|
|
||
| Styleguidist will display a JSDoc comment block at your component's class declaration. Also, it will pick up props that your component uses from propTypes declarations and display them in a nice table together with their defaults, accepted values (where appropriate) and accompanying JSDoc comments. |
There was a problem hiding this comment.
- Not only classes, functional components too.
- “props that your component uses” → “your component‘s props”?
- “nice” → “”.
Codecov Report
@@ Coverage Diff @@
## next #322 +/- ##
=======================================
Coverage 91.84% 91.84%
=======================================
Files 70 70
Lines 956 956
Branches 193 193
=======================================
Hits 878 878
Misses 78 78Continue to review full report at Codecov.
|
n1313
force-pushed
the
minor-text-fixes
branch
from
fd34503 to
a43e9b9
Compare
|
🔥 |
This was referenced Aug 17, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR cleans up grammar and fixes a few typos in the docs.