docs: consistent api reference throughout components #5821
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
driskull
approved these changes
Nov 29, 2022
| @@ -40,19 +40,19 @@ export class DatePickerDay implements InteractiveComponent { | |||
| /** Day of the month to be shown. */ | |||
| @Prop() day!: number; | |||
|
|
|||
There was a problem hiding this comment.
I wonder if we should undocument these internal date picker components altogether since they aren't designed to be used by an end user.
There was a problem hiding this comment.
We can remove, as long as the documentation makes sense to the devs and is understandable without the comments when interacting with the components.
Tried to only match the common or same named props for consistency for the devs in those cases, and we could definitely omit altogether if that's the recommend approach. WDYT @driskull?
There was a problem hiding this comment.
Lets revisit it later before 1.0.
This component isn't designed for a user to ever read its doc or place it in the DOM.
geospatialem
deleted the
geospatialem/4442-finalize-component-api-refs
branch
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.
Related Issue: #4442
Summary
Includes consistency across API references, this PR finalizes the style guide across all components.
Also includes the removal of the optional "
?" JSDoc tags for the components listed below.Components included:
date-pickerdropdowndropdown-groupdropdown-itemfabfilterflowflow-itemiconinline-editable