Skip to content

Array api docs #24626

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
merged 11 commits into from
Jan 5, 2019
Merged

Array api docs #24626

merged 11 commits into from
Jan 5, 2019

Conversation

TomAugspurger
Copy link
Contributor

Closes
#24066

cc @datapythonista @jorisvandenbossche there are a few closely related changes here.

  • removed api.scalars. I think it's more useful to present "Here are all pandas extensions", and then sub-divide into array / scalar / dtype. I think arrays are the most prominent of these, so I I've named the file api/arrays.rst
  • Moved pd.array to api/arrays.rst
  • Moved Categorical from api/series.rst to api/arrays.rst
  • Re-written the accessor section and moved / left those in api/series.rst
  • Added DatetimeArray (the original point of this PR)

I have quite a few warnings to cleanup, but wanted a +1 on the general reorganization before putting more time into it.

Datetimelike Properties
-----------------------
~~~~~~~~~~~~~~~~~~~~~~~
Copy link
Contributor Author

@TomAugspurger TomAugspurger Jan 4, 2019

Choose a reason for hiding this comment

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

These were all moved down one level. The TOC is now

Accessors
    - dt
    - str
    - cat
    - sparse

Rather than having them all at the top-level of this section.

@TomAugspurger
Copy link
Contributor Author

The metaprogramming to create all the Int* dtypes is causing issues with sphinx / numpydoc

screen shot 2019-01-04 at 3 37 06 pm

@codecov
Copy link

codecov bot commented Jan 4, 2019

Codecov Report

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

Impacted file tree graph

@@             Coverage Diff             @@
##           master   #24626       +/-   ##
===========================================
- Coverage   92.38%      43%   -49.38%     
===========================================
  Files         166      166               
  Lines       52395    52395               
===========================================
- Hits        48403    22534    -25869     
- Misses       3992    29861    +25869
Flag Coverage Δ
#multiple ?
#single 43% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/io/formats/latex.py 0% <0%> (-100%) ⬇️
pandas/core/categorical.py 0% <0%> (-100%) ⬇️
pandas/io/sas/sas_constants.py 0% <0%> (-100%) ⬇️
pandas/tseries/plotting.py 0% <0%> (-100%) ⬇️
pandas/tseries/converter.py 0% <0%> (-100%) ⬇️
pandas/io/formats/html.py 0% <0%> (-99.37%) ⬇️
pandas/core/groupby/categorical.py 0% <0%> (-95.46%) ⬇️
pandas/io/sas/sas7bdat.py 0% <0%> (-91.17%) ⬇️
pandas/io/sas/sas_xport.py 0% <0%> (-90.15%) ⬇️
pandas/core/tools/numeric.py 10.44% <0%> (-89.56%) ⬇️
... and 124 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 cb31b2b...a5ac93d. Read the comment docs.

@codecov
Copy link

codecov bot commented Jan 4, 2019

Codecov Report

Merging #24626 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #24626   +/-   ##
=======================================
  Coverage   92.38%   92.38%           
=======================================
  Files         166      166           
  Lines       52395    52395           
=======================================
  Hits        48403    48403           
  Misses       3992     3992
Flag Coverage Δ
#multiple 90.8% <ø> (ø) ⬆️
#single 43% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/core/arrays/array_.py 100% <ø> (ø) ⬆️
pandas/core/generic.py 96.62% <ø> (ø) ⬆️
pandas/core/frame.py 96.92% <ø> (ø) ⬆️
pandas/core/arrays/sparse.py 92.17% <ø> (ø) ⬆️

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 cb31b2b...d650fa1. Read the comment docs.

Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

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

Really nice, better organized this way. Didn't review with great detail, but looks good.

I just don't quite understand the hierarchy in arrays.rst. Seems to me that Datetime Data should be under Pandas Arrays and not at the same level. May be I'm just not understanding it well.

Also, I tried to be consistent with the blank lines when I splitted api.rst, and I used:

A title
-------
Not a blank line between the ----- line and this.

Not really important, but in this PR some times blank lines are used, and some times are not.

@TomAugspurger
Copy link
Contributor Author

You're correct about the heading levels. I'll fix those.

@jreback jreback merged commit 33d1ca8 into pandas-dev:master Jan 5, 2019
@jreback
Copy link
Contributor

jreback commented Jan 5, 2019

thanks!

Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019
Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019
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.

3 participants