-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve addon-info
README options documentation
#1732
Conversation
Added more info about options available
Codecov Report
@@ Coverage Diff @@
## master #1732 +/- ##
=======================================
Coverage 21.18% 21.18%
=======================================
Files 252 252
Lines 5694 5694
Branches 679 692 +13
=======================================
Hits 1206 1206
+ Misses 3979 3946 -33
- Partials 509 542 +33
Continue to review full report at Codecov.
|
inline: true, | ||
maxPropsIntoLine: 1, | ||
header: false, // Toggles display of header with component name and description | ||
inline: true, // Displays info inline vs click button to view |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tenshiemi, thank you for pointing us to this lack of documentation!
There're some more options:
source
, propTables
, propTablesExclude
, styles
Could you also add them if you want? otherwise, we'll do it ourselves
Hi @tenshiemi Sorry about the confusion, but thank you so much for taking the time to make a PR, to improve! Truly appreciated! Do you want to take a look at @usulpro's comments, that'd be fantastic. If you're stretched on time, that's fine, we can merge as is, and @usulpro will add it, I think. |
I was going to do big update of So I just add some additional notes |
addon-info
README options documentation
Added more info about options available since it was confusing