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

RFC: Rename --gfm to --comments #139

Closed
joeyespo opened this issue Aug 28, 2015 · 2 comments
Closed

RFC: Rename --gfm to --comments #139

joeyespo opened this issue Aug 28, 2015 · 2 comments

Comments

@joeyespo
Copy link
Owner

There's been a few issues caused by the confusion of what --gfm does:

I also see --gfm being used in a lot of --export examples. I wonder if that's the intention, or if people saw "--gfm" and thought "oh, GitHub Flavored Markdown, that's what I want":

As a reminder, --gfm comes directly from the GitHub API, but that doesn't mean we can't use a more meaningful name in Grip.

I'm thinking of renaming it to --comments, since that removes any ambiguity of what it's rendering. --issues is another suggestion (or as an alias), but in a way, all issues are comments, so I think using the more general name will be clear enough. It'll certainly be more clear than --gfm.

Thoughts from anyone here?

@joeyespo
Copy link
Owner Author

Renamed to --user-content in #150. The name comes from the GitHub API docs.

@clawoflight
Copy link

Yeah, that will clear up a lot of confusion :)

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

2 participants