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

allow ipython help subcommand syntax #1465

Merged
merged 3 commits into from Mar 3, 2012
Merged

Conversation

minrk
Copy link
Member

@minrk minrk commented Mar 2, 2012

We use git-style subcommands, and should support git-style help to match.

Implementation-wise, simply transforms ipython help subcommand to ipython subcommand -h

As requested by @jdh2358

Implementation-wise, simply transforms argv to `ipython subcommand -h`

We use git-style subcommands, and should support git-style help to match.

As requested by @jdh2358
also recommend `ipython help subcmd` syntax instead of `ipython subcmd -h`
ipython profile -h # show the help string for the profile subcmd
ipython help profile # show the help for the profile subcmd

ipython notebook # start the IPython notebook
Copy link
Member

Choose a reason for hiding this comment

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

can we move this up above profile? or have profile be listed first here (as it is further up in the file) for consistency?

@ivanov
Copy link
Member

ivanov commented Mar 3, 2012

other than that, looks good and tests still pass here.

I've been thinking about how it'd be nice if we actually paged the help, the way git does by default

@jdh2358
Copy link

jdh2358 commented Mar 3, 2012

This works exactly as I was hoping. Thanks!

@minrk
Copy link
Member Author

minrk commented Mar 3, 2012

reordered per @ivanov's request.

minrk added a commit that referenced this pull request Mar 3, 2012
allow `ipython help subcommand` syntax

We use git-style subcommands, and should support git-style help to match.
@minrk minrk merged commit 6cbd0fb into ipython:master Mar 3, 2012
mattvonrocketstein pushed a commit to mattvonrocketstein/ipython that referenced this pull request Nov 3, 2014
allow `ipython help subcommand` syntax

We use git-style subcommands, and should support git-style help to match.
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