Skip to content

DOC: Update link and description of the Spyder IDE in Ecosystem docs #22136

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

Merged

Conversation

CAM-Gerlach
Copy link
Contributor

@CAM-Gerlach CAM-Gerlach commented Jul 30, 2018

Over the past few years, Spyder, a PyQt-based open source Python IDE focused on data science (comparable to MATLAB and Rstudio, but developed by community volunteers instead of a for-profit company), has incorporated a deep swath of pandas-specific features and integration. We've also set up a new, modern website for the project, and a new documentation site as well explaining these, which should be linked to instead of the current one.

Accordingly, this PR does a few simple things, split into separate commits to make it easy to modify or revert any of the changes if undesired:

  • It updates the Spyder URL to point to our new main website, in HTTPS
  • It uses a more up to date one-liner description of Spyder itself, and principally focuses on a greatly expanded list of ways Spyder directly interacts with pandas and offers tools for working with Series and DataFrame objects.
    • As part of this, it embeds links to our new modern, online documentation that describes how these features work, for users to easily reference
  • It also cleans up a few stray trailing spaces present in the Ecosystem docs (I can revert this if undesired)

I included a fair amount of detail in the different distinct ways Spyder interacts with pandas objects and the specific features it offers when working with such, but if you think its too long I can cut down the central paragraph accordingly; just let me know and I'll do it promptly.

Thanks!

@WillAyd WillAyd added the Docs label Jul 30, 2018
@CAM-Gerlach
Copy link
Contributor Author

Also, for reference, part of the broader effort in spyder-ide/spyder-docs#39

capabilities of a scientific environment like MATLAB or Rstudio.

Its `Variable Explorer <https://docs.spyder-ide.org/variableexplorer.html>`__
allows users to view, manipulate and edit pandas Index, DateTimeIndex, Series,
Copy link
Member

@mroeschke mroeschke Jul 30, 2018

Choose a reason for hiding this comment

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

Small nits:

  • DateTimeIndex --> DatetimeIndex

  • By TimeSeries does this mean Timestamp objects? Pandas doesn't strictly have a TimeSeries object though is great for timeseries data.

Otherwise LGTM as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

DateTimeIndex --> DatetimeIndex

Thanks, fixed.

By TimeSeries does this mean Timestamp objects? Pandas doesn't strictly have a TimeSeries object though is great for timeseries data.

Silly mistake on my part; I've been doing too much developing and not enough using Spyder and the PyData stack lately. I got it confused with DatetimeIndex, although Spyder does support editing Timestamps, periods, etc. as well as standard library datetime dates. Just removed it instead.

@codecov
Copy link

codecov bot commented Jul 30, 2018

Codecov Report

Merging #22136 into master will decrease coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #22136      +/-   ##
==========================================
- Coverage   92.07%   92.05%   -0.03%     
==========================================
  Files         170      169       -1     
  Lines       50688    50709      +21     
==========================================
+ Hits        46671    46679       +8     
- Misses       4017     4030      +13
Flag Coverage Δ
#multiple 90.46% <ø> (-0.03%) ⬇️
#single 42.25% <ø> (-0.06%) ⬇️
Impacted Files Coverage Δ
pandas/util/_depr_module.py 67.44% <0%> (-11.63%) ⬇️
pandas/core/arrays/datetimelike.py 94.02% <0%> (-1.04%) ⬇️
pandas/core/internals/blocks.py 93.83% <0%> (-0.62%) ⬇️
pandas/core/dtypes/missing.py 92.98% <0%> (-0.59%) ⬇️
pandas/core/series.py 93.72% <0%> (-0.4%) ⬇️
pandas/core/dtypes/common.py 94.87% <0%> (-0.34%) ⬇️
pandas/core/reshape/reshape.py 99.54% <0%> (-0.25%) ⬇️
pandas/core/arrays/categorical.py 95.75% <0%> (-0.21%) ⬇️
pandas/core/indexes/datetimes.py 95.54% <0%> (-0.14%) ⬇️
pandas/core/arrays/interval.py 92.55% <0%> (-0.05%) ⬇️
... and 28 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c272c52...d8d13f0. Read the comment docs.

@CAM-Gerlach
Copy link
Contributor Author

@mrocklin Addressed both your comments; thanks.

allows users to view, manipulate and edit pandas Index, DatetimeIndex, Series,
and DataFrame objects with a full GUI, including the ability to
sort by column, copy and modify individual values, display a "heatmap"
per-column or globally, convert column data types and more, all with user- or
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a nice description, but a bit long, can you make a little shorter? otherwise lgtm.

Copy link
Contributor Author

@CAM-Gerlach CAM-Gerlach Aug 2, 2018

Choose a reason for hiding this comment

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

Yup, as mentioned above I figured it might be a little long and was prepared to cut it some if requested. I cut it down from 22 lines to 15, a reduction of essentially 1/3, and matching the length of the Jupyter section. Is that good enough?

@jreback jreback added this to the 0.24.0 milestone Aug 2, 2018
capabilities of a scientific environment like MATLAB or Rstudio.

Its `Variable Explorer <https://docs.spyder-ide.org/variableexplorer.html>`__
allows users to view, manipulate and edit pandas Index, DatetimeIndex, Series,
Copy link
Contributor

Choose a reason for hiding this comment

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

you might want to use double-backticks here on Index, DTI, Series etc

Copy link
Contributor Author

@CAM-Gerlach CAM-Gerlach Aug 2, 2018

Choose a reason for hiding this comment

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

Yep, not sure how I missed that. Thanks; Implemented.

@CAM-Gerlach
Copy link
Contributor Author

CAM-Gerlach commented Aug 7, 2018

Anything more you need from me on this? (Its one of the very last blockers for closing out spyder-ide/spyder-docs#39 )

Also, not sure what's up with Travis but everything points to it being a random/unrelated failure.


Most pandas classes, methods and data attributes can be autocompleted in
Spyder's `Editor <https://docs.spyder-ide.org/editor.html>`__ and
`IPython Console <https://docs.spyder-ide.org/ipythonconsole.html>__,
Copy link
Member

Choose a reason for hiding this comment

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

You are missing the closing backtick on this line and the one below

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Silly mistake on my part; thanks for the catch. Fixed.

Copy link
Member

@jorisvandenbossche jorisvandenbossche left a comment

Choose a reason for hiding this comment

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

Apart from the missing backticks, looks good to me!

Copy link
Member

@WillAyd WillAyd left a comment

Choose a reason for hiding this comment

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

Lgtm @jreback - ok to merge?

@CAM-Gerlach
Copy link
Contributor Author

@jreback Hey, any updates on this? Its one of the very last blockers for spyder-ide/spyder-docs#39 , which will allow us to remove our old docs soon given that users keep stumbling into them and getting confused as to why things don't look or work like listed there. Let me know if there's anything more I need to do. Thanks!

@jorisvandenbossche jorisvandenbossche merged commit e2e1a10 into pandas-dev:master Sep 5, 2018
@jorisvandenbossche
Copy link
Member

@CAM-Gerlach Thanks!

rhysparry added a commit to rhysparry/pandas that referenced this pull request Sep 5, 2018
* master:
  DOC: Update link and description of the Spyder IDE in Ecosystem docs (pandas-dev#22136)
  BUG: resample with TimedeltaIndex, fenceposts are off (pandas-dev#22488)
  Use dispatch_to_series where possible (pandas-dev#22572)
  BLD: Fix openpyxl to 2.5.5 (pandas-dev#22601)
@CAM-Gerlach
Copy link
Contributor Author

Thanks @jorisvandenbossche , @jreback , @WillAyd , and @mroeschke !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants