Skip to content

Fix rendering issue in "formatting" help topic - #4661

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

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

Conversation

@pbnj

@pbnj pbnj commented Nov 1, 2021

Copy link
Copy Markdown
Contributor

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
mislav
mislav suggested changes Nov 1, 2021
View reviewed changes

@mislav mislav left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you!

Comment thread pkg/cmd/root/help_topic.go Outdated
Comment thread pkg/cmd/root/help_topic.go Outdated
mislav
mislav suggested changes Nov 1, 2021
View reviewed changes

@mislav mislav left a comment

Copy link
Copy Markdown
Contributor

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.

Comment thread pkg/cmd/root/help_topic.go
mislav
mislav suggested changes Nov 1, 2021
View reviewed changes

@mislav mislav left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Getting there!

Comment thread pkg/cmd/root/help_topic.go Outdated
Comment thread pkg/cmd/root/help_topic.go Outdated
Comment thread pkg/cmd/root/help_topic.go Outdated
@mislav mislav changed the title fix: fix rendering issue Fix rendering issue in "formatting" help topic Nov 1, 2021
mislav
mislav approved these changes Nov 2, 2021
View reviewed changes

@mislav mislav left a comment

Copy link
Copy Markdown
Contributor

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

pbnj commented Nov 2, 2021

Copy link
Copy Markdown
Contributor Author

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

image

@mislav

mislav commented Nov 3, 2021 •
edited
Loading

Copy link
Copy Markdown
Contributor

@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 ✌️

@VictorBatta VictorBatta mentioned this pull request Dec 4, 2021
Closed
@jenkins-infra-bot jenkins-infra-bot mentioned this pull request Dec 20, 2021
Merged
Shan2017
Shan2017 reviewed Jan 13, 2022
View reviewed changes

@Shan2017 Shan2017 left a comment

Copy link
Copy Markdown

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

Reviewers

@samcoe samcoe Awaiting requested review from samcoe samcoe is a code owner automatically assigned from cli/code-reviewers
2 more reviewers
@Shan2017 Shan2017 Shan2017 left review comments
@mislav mislav mislav approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

cli.github.com help topic page not rendering properly

4 participants

@pbnj @mislav @Shan2017 @cliAutomation