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

Help is shown as raw markdown #1919

Closed
stsewd opened this issue Oct 27, 2018 · 4 comments
Closed

Help is shown as raw markdown #1919

stsewd opened this issue Oct 27, 2018 · 4 comments

Comments

@stsewd
Copy link

stsewd commented Oct 27, 2018

When executing hub pr, the help is shown, but it contains some markdown syntax that looks confusing on the terminal, especially _list_ and _checkout_

Related code

https://github.com/github/hub/blob/b15d8de5e468f32653ff3bdfc2224cd3e429080a/commands/pr.go#L25-L29

@mislav
Copy link
Owner

mislav commented Oct 29, 2018

Thanks; good catch! We should improve this so that the appropriate, properly formatted man page is shown.

@seanprashad
Copy link

Hey everyone, I'd love to give this a shot as my first PR for Hub!

Funny enough, I've just begun maintaining a project and needed a way to automate checking out contributors PRs instead of adding their remote, fetching, and checking out their branch 😅

From what I understand, the _ denotes italicized text, which we do not want showing at all - am I understanding this correctly?

@mislav
Copy link
Owner

mislav commented Nov 12, 2018

@seanprashad Thanks for offering to help out!

I would say that the main problem here is that running hub pr displays help text that is in a raw format (i.e. includes special formatting characters such as _), while hub help pr displays a nice man page. Perhaps running hub pr should be equivalent to running hub help pr.

@seanprashad
Copy link

Great, that makes sense @mislav - I'll open a PR in a little while 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants