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

Correct docstring of ipython.py #2859

Merged
merged 2 commits into from Jan 28, 2013
Merged

Conversation

asmeurer
Copy link
Contributor

The script installed by setup.py is auto-generated by distutils.

Fixes #2858.

The script installed by setup.py is auto-generated by distutils.

Fixes ipython#2858.
@minrk
Copy link
Member

minrk commented Jan 28, 2013

I misspoke - it's setuptools that does console_scripts, there are hardcoded scripts that are ~never used in IPython/scripts and IPython/parallel/scripts.

@asmeurer
Copy link
Contributor Author

So should those other scripts be deleted?

@minrk
Copy link
Member

minrk commented Jan 28, 2013

In the (fairly rare, these days) cases of downloading a tarball and running setup.py install, I think they are still used.
In any case, there was never any reason for ipython.py to mention where the entry point scripts came from.

@asmeurer
Copy link
Contributor Author

I personally came across this because I wanted to know what the entry point script was. I initially thought it was ipython.py, and only learned otherwise after reading the docstring (and opening #2858). So I think the note is useful, if that's what you mean.

@minrk
Copy link
Member

minrk commented Jan 28, 2013

I only mean it doesn't have to describe the particulars of the installed scripts - it just needs to identify itself as not that.

@asmeurer
Copy link
Contributor Author

I personally think it's useful. In fact, after learning that you could do that from all this, I implemented it in another project (inducer/pudb#54).

@minrk
Copy link
Member

minrk commented Jan 28, 2013

fair enough.

minrk added a commit that referenced this pull request Jan 28, 2013
Correct docstring of ipython.py

had archaic reference to script location.

closes #2858
@minrk minrk merged commit 72811c3 into ipython:master Jan 28, 2013
minrk added a commit that referenced this pull request Mar 5, 2013
The script installed by setup.py is auto-generated by distutils.

Fixes #2858.
mattvonrocketstein pushed a commit to mattvonrocketstein/ipython that referenced this pull request Nov 3, 2014
Correct docstring of ipython.py

had archaic reference to script location.

closes ipython#2858
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.

Where is the installed ipython script?
2 participants