Add JSDoc documentation to ListFilterOption type#2408
Draft
Lang-Qiu wants to merge 1 commit into
Draft
Conversation
Contributor
|
Hi @Lang-Qiu - thank you for opening this PR and for your interest in contributing. Is this PR ready for review? |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 public type
ListFilterOptionin the list filters component lacked JSDoc comments, reducing code readability and documentation. This type is generic and used for filter options, so clear documentation helps developers understand its purpose and usage.Changes
ListFilterOptiontype insrc/renderer/lib/components/list-filters/types.ts, including a@descriptionand@templatetag to explain the type and its generic parameter.Verification
tsc --noEmit).