-
Notifications
You must be signed in to change notification settings - Fork 21
Documentation: Add JSDoc to types.ts #103
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershacktoberfestHacktoberfest is a yearly developer festival where the participation in Open Source is appreciatedHacktoberfest is a yearly developer festival where the participation in Open Source is appreciatedhelp wantedExtra attention is neededExtra attention is neededtrivial
Description
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershacktoberfestHacktoberfest is a yearly developer festival where the participation in Open Source is appreciatedHacktoberfest is a yearly developer festival where the participation in Open Source is appreciatedhelp wantedExtra attention is neededExtra attention is neededtrivial
What should be changed?
Description
For better usage of our props we can document them a bit more. This issue is quite easy and just involves documentation but also some understanding of how our components work.
A pull request for this issue should just add JSDoc comments for the
src\types.tsfile.To explain from my own words what the things are used for:
IInOptionIInOption. An option that will be shown on the left side of the selector in the component. You can mention that another parameter was added to the interface.IOutOptionPlease rephrase these sentences so they makes sense. Resources that helped me to understand JSDoc comments:
Files involved
src\types.ts