[TypeScript] Add inline documentation for most common components #9234
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
fzaninotto
changed the title
djhi
requested changes
Aug 30, 2023
| filter?: FilterPayload; | ||
|
|
||
| /** | ||
| * The filter to apply when calling getList if the filter is empty. |
There was a problem hiding this comment.
Aren't those the default values of the always on filter inputs?
There was a problem hiding this comment.
yes, but we don't need to go into details here. The link to the doc is enough.
Co-authored-by: Gildas Garcia <1122076+djhi@users.noreply.github.com>
djhi
approved these changes
Aug 30, 2023
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.
Problem
The analytics for the react-admin docs show that developers mostly visit the pages dedicated to the
<Admin>,<List>, and<Datagrid>components.If they need to read the doc, it means they don't have the necessary information at hand.
Solution
Document the proptypes of these components, so that IntelliSense can provide inline usage and doc link.
This is a limited experiment to see if it facilitates onboarding of new developers.