Hub: Help is shown as raw markdown

Created on 27 Oct 2018  路  4Comments  路  Source: github/hub

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

bug docs

Most helpful comment

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

All 4 comments

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

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?

@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.

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

Was this page helpful?
0 / 5 - 0 ratings