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

Update docs to use underscores #83

Closed
wants to merge 1 commit into from
Closed

Update docs to use underscores #83

wants to merge 1 commit into from

Conversation

catsby
Copy link
Contributor

@catsby catsby commented May 22, 2014

All the commands should be underscores , update docs (and thus heroku help pg output) to reflect

@will
Copy link
Contributor

will commented May 22, 2014

this is the opposite of #39

@catsby
Copy link
Contributor Author

catsby commented May 22, 2014

Indeed... I had forgotten about 39.

I opened this to consolidate on _. #39 updates the docs to all - but doesn't actually change the methods.

I don't strongly care about _ vs -, as long as documentation and invocation match. The sprinkling of alias_command methods cover this I suppose, if we're OK with that

@msakrejda
Copy link
Contributor

Oh hmm. I thought that the aliases were set up the other way around. It looks like help on the commands now calls them out as aliases:

maciek@gamera:~$ heroku help pg:index-usage
Alias: pg:index-usage redirects to pg:index_usage
Usage: heroku pg:index-usage [DATABASE]

 calculates your index hit rate (effective databases are at 99% and up)

heroku help pg:index_usage shows the same thing but without the alias blurb. This is definitely somewhat confusing, given that the docs treat the dash commands as first-class. Should I swap the aliases?

@will
Copy link
Contributor

will commented Oct 24, 2014

Should I swap the aliases?

yes

@msakrejda msakrejda mentioned this pull request Oct 24, 2014
@msakrejda
Copy link
Contributor

Swapped in #97, so this is obsolete.

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.

None yet

3 participants