-
-
Notifications
You must be signed in to change notification settings - Fork 431
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
Fix Underscores in Headings #1045
Fix Underscores in Headings #1045
Conversation
@johnnyreilly would love to get your thoughts on this before proceeding further. Essentially, I propose going from this: transpileOnly (boolean) (default=false)" transpileOnly
" Just to be extra specific, I'm saying I want to propose having the type of value and default value in a table below the heading, instead of in the heading itself in parentheses. I chose this solution because: |
Yeah I think this is great! Thanks for proposing it! Do you want to submit a full PR? Thanks again! |
Woo! Definitely. Going to update then will mark ready for review when it's complete! |
#### instance | ||
| Type | Default Value | | ||
|------|--------------| | ||
| `string` | `TODO`| |
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.
Does this option have a default value? I didn't see one in the heading and wanted to ask.
If not, I can remove that column
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.
tagging @johnnyreilly just in case you didn't see this
@johnnyreilly this is ready to go! |
Nice one! I'll merge as soon as CI finishes doing it's thing. Thanks! |
Description
The goal of this is to propose a new format for part of the
README
, which will:Screencast
Here's what it will look like: