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 Spyder link, description and related distribution info on Topical Software and Install pages #259

Merged
merged 4 commits into from
Jul 30, 2018

Conversation

CAM-Gerlach
Copy link
Contributor

As it says on the tin, this PR does a few simple but related things, split into small, focused commits so it may be easily examined and (if necessary) changed or even reverted:

On the Topical Software Page:

  • Updates the very outdated Spyder link to point to the IDE's current website
  • Updates the description of the IDE to better describe its current capabilities and integration into the NumPy/SciPy/Matplotlib/Pandas etc workflow
  • Updates/removes the highly outdated parenthetical around its existing reference in the Python(x, y) distribution
  • Adds the WinPython distribution (which also includes Spyder) to the page with a short description to be consistent with its existing inclusion on the Install page, given it is very similar to Python(x, y) but much more up to date/maintained, although currently Windows-only

On the Install page:

  • Makes the existing Spyder IDE reference in Python(x, y) into a link, to make clear what it is referring to for unfamiliar users
  • Improves the WinPython description to be consistent with the Python(x, y), including a reference to Spyder (unlinked)

Let me know if you'd like me to make any further changes, or even revert something. I didn't see a contributing guide, so hopefully this is okay. Thanks!

@CAM-Gerlach
Copy link
Contributor Author

Also, for reference, part of spyder-ide/spyder-docs#39

@@ -83,10 +83,11 @@ Working environments
====================

- `Anaconda <https://www.continuum.io/downloads>`__: A free, enterprise-ready Python distribution with hundreds of cross-platform tested and optimized packages for Mac OS X, Windows, and Linux users. Installs into a single directory. Doesn't require root or local administrator privileges. Contains the package and environment manager tool, `conda <http://conda.pydata.org/>`.
- `Python(x,y) <http://python-xy.github.io/>`__: A complete distribution for Windows or Ubuntu users containing all the packages needed for full Python distribution for scientific development, including Qt based GUI design. Also includes Spyder (formerly called Pydee), a Python IDE suited to scientific development.
- `Python(x,y) <http://python-xy.github.io/>`__: A complete distribution for Windows or Ubuntu users containing all the packages needed for full Python distribution for scientific development, including Qt based GUI design. Also includes Spyder (see below), a Python IDE suited to scientific development.
- `WinPython <https://winpython.github.io>`_: Similar to Python(x, y), another comprehensive distribution including scientific packages and the Spyder IDE. Windows only, but much more up to date.
Copy link
Member

Choose a reason for hiding this comment

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

I don't mean harm with my comment but maybe, to acknowledge Python(x,y) efforts, can we change the last part to

has seen relatively more active maintenance compared to Python(x,y)

or something along those lines? Because they have been instrumental for many people who jump on the bandwagon of Python, even today, before Anaconda was a thing to resolve package clashes. And I really wish that it doesn't get dismissed just due to staying out of touch for a while.

Copy link
Member

Choose a reason for hiding this comment

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

Also maybe mentioning that it is Py2 only (if I remember correctly)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't mean harm with my comment but maybe, to acknowledge Python(x,y) efforts...

Actually, I originally had wording similar to what you suggested, but I actually thought that sounded more harmful to Python(x, y) than what I put. I edited both the install page and the cited section to be more along the lines of your suggestion; let me know what you think.

Pierre was apparently the original creator and maintainer of both (as well as Spyder itself), although I'm not really familiar with the exact history other than recently.

Also maybe mentioning that it is Py2 only (if I remember correctly)?

Python(x, y), yes, since it hasn't been maintained much recently. WinPython closely tracks the latest Python 3 releases. Included language to clarify both.

@CAM-Gerlach
Copy link
Contributor Author

@ilayn Thanks for your feedback. I rewrote Python(x, y) and WinPython sections in both Topical Software and Installation to hopefully address both of your concerns.

@ilayn
Copy link
Member

ilayn commented Jul 30, 2018

I think this is much better and can go in. Thanks for the fix. Unlike the main repository, the website changes has to be pushed manually hence pinging @pv, @rgommers to consider this.

@CAM-Gerlach
Copy link
Contributor Author

Great! Thanks for your help and suggestions, @ilayn

@rgommers rgommers merged commit 5bb26a6 into scipy:master Jul 30, 2018
@rgommers
Copy link
Member

LGTM, merged. Thanks @CAM-Gerlach and @ilayn

@CAM-Gerlach
Copy link
Contributor Author

Thanks for the merge @rgommers !

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.

3 participants