Skip to content

Remove mentioning python 2 in the development documentation - #7295

Closed
dongzili wants to merge 1 commit into
astropy:masterfrom
dongzili:update_intall_dev_doc
Closed

dongzili wants to merge 1 commit into
astropy:masterfrom
dongzili:update_intall_dev_doc

Conversation

@dongzili

Copy link
Copy Markdown

fixes #7287

@astropy-bot

astropy-bot Bot commented Mar 16, 2018 •

Copy link
Copy Markdown

Hi there @fleaf5 👋 - thanks for the pull request! I'm just a friendly 🤖 that checks for issues related to the changelog and making sure that this pull request is milestoned and labeled correctly. This is mainly intended for the maintainers, so if you are not a maintainer you can ignore this, and a maintainer will let you know if any action is required on your part 😃.

I noticed the following issue with this pull request:

  • The milestone has not been set (this can only be set by a maintainer)

Would it be possible to fix this? Thanks!

If there are any issues with this message, please report them here.

@pllim
pllim requested a review from mhvk March 16, 2018 15:58
@pllim pllim added this to the v3.0.2 milestone Mar 16, 2018
In the directory where your copy of `Astropy`_ is type::

python setup.py develop
python3 setup.py develop

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

leave it as python, we don't support python 2 any more, thus python is by definition is assumed to be python3, etc.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@bsipocz - I rather disagree - for many distributions this means you'll run python2 - it is only when you activate a virtual environment that is python3 based that python equals python3. I would say that explicit is better than implicit here.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👎 on python3 from me. What if when python4 is available? This document would ask everyone to only install Astropy on Python 3 but not 4. Is that desirable? Wouldn't it be safer to have setup.py check for sys.version and raise an exception there for Python < 3?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@mhvk - This is the dev docs for a python 3 only project. Is it too much to ask for prospective contributors to know whether they run python 2 or python 3 when they type python?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it is silly for copy & paste not to give the right answer. Please realize that not everybody works on a mac with conda! On linux/debian, this simply fails. I had students trying to set up the development version today, and this failed for this reason (@fleaf5 is one of them). While if we change it to python3 we show that we're python3 only and it will always work (no python4 on the horizon; we can change that when that comes - after my retirement!).

p.s. The larger issue is that this text is rather more completely out of date, which is the problem with developers writing introductory text.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Note also that python3 does work on MacOS X with conda.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

But we could just mention both python and python3??

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I like the pip install -e workaround.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Let's just hope it's not pip3 on some platforms ;)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

well, then we go back to my first point above, that some assumption about basic knowledge and control of the python environment is not really that unreasonable for the prospective contributors.

@bsipocz

bsipocz commented Apr 20, 2018

Copy link
Copy Markdown
Member

This now has a conflict and needs a rebase anyway to get rid of the unrelated CI issue, thus I'm remilestoning.

@bsipocz bsipocz modified the milestones: v3.0.2, v3.0.3 Apr 20, 2018
@bsipocz bsipocz modified the milestones: v3.0.3, v3.0.4 May 30, 2018
@bsipocz bsipocz removed this from the v3.0.4 milestone Jul 25, 2018
@astropy-bot

astropy-bot Bot commented Aug 23, 2018

Copy link
Copy Markdown

Hi humans 👋 - this pull request hasn't had any new commits for approximately 5 months. I plan to close this in a month if the pull request doesn't have any new commits by then.

In lieu of a stalled pull request, please consider closing this and open an issue instead if a reminder is needed to revisit in the future. Maintainers may also choose to add keep-open label to keep this PR open but it is discouraged unless absolutely necessary.

If this PR still needs to be reviewed, as an author, you can rebase it to reset the clock. You may also consider sending a reminder e-mail about it to the astropy-dev mailing list.

If you believe I commented on this pull request incorrectly, please report this here.

@astropy-bot

astropy-bot Bot commented Sep 27, 2018

Copy link
Copy Markdown

⏰ Time's up! ⏰

I'm going to close this pull request as per my previous message. If you think what is being added/fixed here is still important, please remember to open an issue to keep track of it. Thanks!

If this is the first time I am commenting on this issue, or if you believe I closed this issue incorrectly, please report this here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation of trying development has python2-only stuff

6 participants