Skip to content

Commit

Permalink
Update documentation/storybook.md
Browse files Browse the repository at this point in the history
Co-authored-by: Aram <[email protected]>
  • Loading branch information
VincentSmedinga and alimpens authored May 21, 2024
1 parent 5fd28f5 commit d749980
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion documentation/storybook.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Controls are automatically generated based on the component’s typing.
### Prop descriptions

We use JSDoc to describe each prop to keep documentation close to the actual definition.
This also helps IDE’s pick up the description and display it in their user interface.
This also helps IDEs pick up the description and display it in their user interface.
The description briefly explains the essence of the prop.
A guideline on how to use the prop may be added, as well as a description of its effect, e.g. visually.
Prevent mentioning the component’s name in a prop description – that should be obvious.
Expand Down

0 comments on commit d749980

Please sign in to comment.