Skip to content

DOC: Clean up of API doc sections #24508

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 1 commit into from
Dec 31, 2018
Merged

DOC: Clean up of API doc sections #24508

merged 1 commit into from
Dec 31, 2018

Conversation

datapythonista
Copy link
Member

Follow up of the splitting of api.rst in #24462.

  • Making better use of the titles and subtitles (in date offsets, the class name, and the properties and methods sections where at the same level for example).
  • We were inconsistently using Attributes and Properties, left just properties, as it was the most common one.
  • Renamed indices.rst to indexing.rst, I think it makes more sense (index.rst is kind of reserved to the home)

@codecov
Copy link

codecov bot commented Dec 30, 2018

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #24508      +/-   ##
==========================================
- Coverage   31.91%    31.9%   -0.02%     
==========================================
  Files         166      166              
  Lines       52400    52428      +28     
==========================================
+ Hits        16722    16725       +3     
- Misses      35678    35703      +25
Flag Coverage Δ
#multiple 30.29% <ø> (-0.02%) ⬇️
#single 31.9% <ø> (-0.02%) ⬇️
Impacted Files Coverage Δ
pandas/core/frame.py 27.95% <0%> (-0.42%) ⬇️
pandas/core/dtypes/inference.py 80% <0%> (+0.96%) ⬆️

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 43c4dcd...96d9671. Read the comment docs.

1 similar comment
@codecov
Copy link

codecov bot commented Dec 30, 2018

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #24508      +/-   ##
==========================================
- Coverage   31.91%    31.9%   -0.02%     
==========================================
  Files         166      166              
  Lines       52400    52428      +28     
==========================================
+ Hits        16722    16725       +3     
- Misses      35678    35703      +25
Flag Coverage Δ
#multiple 30.29% <ø> (-0.02%) ⬇️
#single 31.9% <ø> (-0.02%) ⬇️
Impacted Files Coverage Δ
pandas/core/frame.py 27.95% <0%> (-0.42%) ⬇️
pandas/core/dtypes/inference.py 80% <0%> (+0.96%) ⬆️

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 43c4dcd...96d9671. Read the comment docs.

@jreback jreback added this to the 0.24.0 milestone Dec 30, 2018
@jreback
Copy link
Contributor

jreback commented Dec 30, 2018

lgtm.

@gfyoung gfyoung merged commit 592eb5e into pandas-dev:master Dec 31, 2018
@gfyoung
Copy link
Member

gfyoung commented Dec 31, 2018

Thanks @datapythonista !

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants