chore: improve documentation consistency #241
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
🦋 Changeset detectedLatest commit: 1eda28b The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Preview URLsEnv: preview |
clintcs
commented
Jul 31, 2023
| @@ -199,7 +210,8 @@ Individual checkboxes can be set to read only by setting the `@isReadOnly` argum | |||
|
|
|||
| ## Attributes and Modifiers | |||
|
|
|||
There was a problem hiding this comment.
Should "Attributes and Modifier" sections also have an "Optional" descriptor?
There was a problem hiding this comment.
I think that makes sense, as they are not "required" 🎉
clintcs
commented
Jul 31, 2023
| @@ -2,12 +2,6 @@ | |||
|
|
|||
| Provides an underlying `<input type="file">` element building on top of the Field component. | |||
|
|
|||
| ## Accepts | |||
There was a problem hiding this comment.
Moved below the label argument (required) documentation.
ynotdraw
approved these changes
Jul 31, 2023
| @@ -199,7 +210,8 @@ Individual checkboxes can be set to read only by setting the `@isReadOnly` argum | |||
|
|
|||
| ## Attributes and Modifiers | |||
|
|
|||
There was a problem hiding this comment.
I think that makes sense, as they are not "required" 🎉
clintcs
force-pushed
the
improve-documentation-consistency
branch
from
293bae5
to
3ebe7ab
Compare
clintcs
force-pushed
the
improve-documentation-consistency
branch
from
3ebe7ab
to
1eda28b
Compare
ynotdraw
approved these changes
Jul 31, 2023
Merged
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.
🚀 Description
🔬 How to Test
As long as the build is green, we're probably good.