Skip to content

Fix rendering issue in "formatting" help topic#4661

Merged
mislav merged 4 commits intocli:trunkfrom
pbnj:patch-1
Nov 2, 2021
Merged

Fix rendering issue in "formatting" help topic#4661
mislav merged 4 commits intocli:trunkfrom
pbnj:patch-1

Conversation

@pbnj
Copy link
Contributor

@pbnj pbnj commented Nov 1, 2021

Closes #4322

@pbnj pbnj requested a review from a team as a code owner November 1, 2021 17:42
@pbnj pbnj requested review from samcoe and removed request for a team November 1, 2021 17:42
Copy link
Contributor

@mislav mislav left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

Copy link
Contributor

@mislav mislav left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is starting to look good, but note that gh help formatting still doesn't show the examples section. This is because the help function for topics like "formatting" is handled by helpTopicHelpFunc() which currently only prints the Long text and ignores the Example field. I think you should amend the function to also print the EXAMPLES header followed by the examples section indented by 2 spaces.

Signed-off-by: Peter Benjamin <petermbenjamin@gmail.com>
Copy link
Contributor

@mislav mislav left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting there!

@mislav mislav changed the title fix: fix rendering issue Fix rendering issue in "formatting" help topic Nov 1, 2021
Copy link
Contributor

@mislav mislav left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! Thank you for your patience.

@mislav mislav enabled auto-merge (squash) November 2, 2021 17:25
@mislav mislav merged commit 175da0f into cli:trunk Nov 2, 2021
@pbnj
Copy link
Contributor Author

pbnj commented Nov 2, 2021

I am not sure if this is related, but now the online docs for formatting seem to be worse off than before:

image

@mislav
Copy link
Contributor

mislav commented Nov 3, 2021

@pbnj The online doc hasn't been regenerated yet after your changes. We update the online manual only on a tagged release. I'll see into getting this page updated specifically after your changes ✌️

Copy link

@Shan2017 Shan2017 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

cli.github.com help topic page not rendering properly

3 participants