Skip to content
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

Merged
merged 6 commits into from
Dec 22, 2019

Conversation

jsjoeio
Copy link
Contributor

@jsjoeio jsjoeio commented Dec 22, 2019

Description

The goal of this is to propose a new format for part of the README, which will:

  • improve readability
  • fix issues with the autogenerated TOC

Screencast

Here's what it will look like:
2019-12-22 11 08 54

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Dec 22, 2019

@johnnyreilly would love to get your thoughts on this before proceeding further.

Essentially, I propose going from this:
"

transpileOnly (boolean) (default=false)

"
to this:
"

transpileOnly

Type Default Value
boolean false

"

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:
a) it doesn't seem like we could fix this with the CLI based on the docs for markdown-toc
b) I think this could improve readability potentially
c) it would fix the same issue #1044 brought up

@johnnyreilly
Copy link
Member

Yeah I think this is great! Thanks for proposing it! Do you want to submit a full PR?

Thanks again!

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Dec 22, 2019

Woo! Definitely. Going to update then will mark ready for review when it's complete!

#### instance
| Type | Default Value |
|------|--------------|
| `string` | `TODO`|
Copy link
Contributor Author

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

Copy link
Contributor Author

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

@jsjoeio jsjoeio marked this pull request as ready for review December 22, 2019 18:12
@jsjoeio
Copy link
Contributor Author

jsjoeio commented Dec 22, 2019

@johnnyreilly this is ready to go!

@johnnyreilly
Copy link
Member

Nice one! I'll merge as soon as CI finishes doing it's thing. Thanks!

@johnnyreilly johnnyreilly merged commit 37a0731 into TypeStrong:master Dec 22, 2019
@jsjoeio jsjoeio deleted the jsjoeio/fix-toc-underscore branch December 22, 2019 22:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants