[Add] props description, descriptions to the component. #3112
Conversation
|
@khushal87 Could you add this feature too? #3105 (comment) |
|
@arpitBhalla This is not decided yet, I will have to talk to mentors. Adding all this will unnecessarily make the component long with descriptions in my opinion. |
|
@khushal87 Its already decided in #3004 |
|
definitely adding single line for preview would not make description lengthy |
Codecov Report
@@ Coverage Diff @@
## next #3112 +/- ##
=======================================
Coverage 83.84% 83.84%
=======================================
Files 78 78
Lines 1684 1684
Branches 669 669
=======================================
Hits 1412 1412
Misses 268 268
Partials 4 4
Continue to review full report at Codecov.
|
src/Avatar/Accessory.tsx
Outdated
| @@ -14,10 +14,15 @@ import { RneFunctionComponent } from '../helpers'; | |||
|
|
|||
| export type AccessoryProps = Partial<IconProps> & | |||
| Partial<ImageProps> & { | |||
| /**Add underlay color to the accessory of avatar. */ | |||
There was a problem hiding this comment.
| /**Add underlay color to the accessory of avatar. */ | |
| /** Add underlay color to the accessory of avatar. */ |
There was a problem hiding this comment.
@khushal87 Can you make this change everywhere? You can find and replace all.
There was a problem hiding this comment.
@dhruvdutt Done, thanks for pointing it out. 🙌
|
@dhruvdutt Can we add preview images and documentation links to description, it would be easy for developer to quickly access docs. |
|
@arpitBhalla The problem with this is that it will also be visible in documentation after parse unless and until we remove it by adding additional conditions. I don't think making the code complex is a good thing, where we already have an underlying props filter complexity which we would be having. Docs are enough to show what the components are used for. This is my opinion. @dhruvdutt what do you say? |
removing 2 lines would not be complex, you can do it after generating markdown files, I guess 🙄 |
|
@arpitBhalla Adding preview image & description link can be picked up separately as an enhancement later. Let's track it at #3115 and add it for all components together since this would need some changes in the comments parsing for filtering during auto-generation of docs. |
What kind of change does this PR introduce?
This PR introduces adding descriptions and props descriptions to the components for auto-generation of docs in the future.
Did you add tests for your changes?
Yes, I have added and configured the tests accordingly.
If relevant, did you update the documentation?
Not required.
Summary
This PR added descriptions and props description to the components except for the class-based components:
Does this PR introduce a breaking change?
No.
Other information
Nothing as such. I have used a common pattern for commenting on the descriptions in the components.
Tags
#gsoc #docs-autogen #khushal87