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.

Sign up for GitHub

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

Jump to bottom

DOC: Add dateutil to intersphinx #24437 #24443

Merged
merged 18 commits into from
Dec 27, 2018
Merged

DOC: Add dateutil to intersphinx #24437 #24443

merged 18 commits into from
Dec 27, 2018

Conversation

benjaminr
Copy link
Contributor

@benjaminr benjaminr commented Dec 26, 2018 •
edited by datapythonista
Loading

@benjaminr
DOC: Fix docstrings with the sections in the wrong order pandas-dev#2…
4446942 
…4280
@benjaminr
DOC: Fix docstrings with the sections in the wrong order pandas-dev#2…
baa2950 
…4280
@benjaminr
Removal of whitespace to satisfy flak8 checks.
c73c5f0
@benjaminr
Merge branch 'master' of https://github.com/pandas-dev/pandas
c042341
@benjaminr
Refactored _doc_template to _common_see_also and used with the substi…
14fe729 
…tution decorator in docstrings where commonly repeated
@benjaminr
Updated CI checks to include GL07 docstring validation.
23350de
@benjaminr
Docstring appends were in the wrong order - this corrects that. Altho…
3d18f6b 
…ugh aggregate method docstrings still have the issue of sharing a docstring with Notes directly after Returns. This means any further appends with a See Also section are out of order.
@benjaminr
Use of format on _shared_docs['aggregate'] docstring usage to get the…
a1db80b 
… order right.
@benjaminr
Merge branch 'master' of https://github.com/pandas-dev/pandas
faac16d
@benjaminr
Merge branch 'master' of https://github.com/pandas-dev/pandas
0a7ed6d
@benjaminr
Updated to code check order and included GL07 in messages.
64af1fc
@benjaminr
Use of substitution to clean up docstring order fix.
3e54918
@benjaminr
Corrected order of see_also and examples string defitions to match do…
5f64fcf 
…cstrings.
@benjaminr
Updated name of _agg_see_also_doc to reflect fact it also contains a …
bdeb8ae 
…summary.
@benjaminr
Fix added import statement to be in the correct order.
fc5fc69
@benjaminr
Merge of upstream changes.
828c03b
@benjaminr
Addition of dateutil docs to intersphinx mapping to pull in objects f…
91d13fe 
…or doc refs.
@benjaminr benjaminr closed this Dec 26, 2018
@benjaminr benjaminr reopened this Dec 26, 2018
@codecov
Copy link

codecov bot commented Dec 26, 2018

Codecov Report

Merging #24443 into master will increase coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #24443      +/-   ##
==========================================
+ Coverage    92.3%   92.31%   +<.01%     
==========================================
  Files         163      163              
  Lines       51977    51977              
==========================================
+ Hits        47979    47980       +1     
+ Misses       3998     3997       -1
Flag Coverage Δ
#multiple 90.71% <ø> (ø) ⬆️
#single 42.99% <ø> (-0.01%) ⬇️
Impacted Files Coverage Δ
pandas/util/testing.py 87.84% <0%> (+0.09%) ⬆️

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 8b4b38f...91d13fe. Read the comment docs.

@codecov
Copy link

codecov bot commented Dec 26, 2018 •
edited
Loading

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #24443   +/-   ##
=======================================
  Coverage    92.3%    92.3%           
=======================================
  Files         163      163           
  Lines       51977    51977           
=======================================
  Hits        47979    47979           
  Misses       3998     3998
Flag Coverage Δ
#multiple 90.71% <ø> (ø) ⬆️
#single 42.99% <ø> (ø) ⬆️

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 8b4b38f...ae6aa27. Read the comment docs.

@datapythonista
Copy link
Member

did you generate the documentation and checked if the link to the dateutil documentation works?

out of curiosity? what order are the intersphinx modules following now?

@benjaminr
Copy link
Contributor Author

I generated the documentation and the dateutil link worked okay for example in the pandas.tseries.offsets.DateOffset doc you initially described.

The order is now alphabetically listed to make it slightly more legible for reading through the list as it grows and changes.

datapythonista
datapythonista approved these changes Dec 26, 2018
View reviewed changes
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.

good, but if the order is alphabetical, you may want to have dateutil the first, not the last :)

@benjaminr
Copy link
Contributor Author

Ah, whoops! I reordered the listing and then added dateutil. Fixed now.

@jreback jreback added this to the 0.24.0 milestone Dec 27, 2018
@jreback jreback merged commit 289285e into pandas-dev:master Dec 27, 2018
@jreback
Copy link
Contributor

jreback commented Dec 27, 2018

thanks @benjaminr

@benjaminr
Copy link
Contributor Author

No probs @jreback

thoo added a commit to thoo/pandas that referenced this pull request Dec 28, 2018
@thoo
Merge remote-tracking branch 'upstream/master' into series-dtype-doc
63c2aef 
* upstream/master: (26 commits)
  DOC: Fixing doc upload (no such remote origin) (pandas-dev#24459)
  BLD: for C extension builds on mac, target macOS 10.9 where possible (pandas-dev#24274)
  POC: _eadata (pandas-dev#24394)
  DOC: Correct location (pandas-dev#24456)
  CI: Moving CircleCI build to Travis (pandas-dev#24449)
  BUG: Infer compression by default in read_fwf() (pandas-dev#22200)
  DOC: Fix minor typo in whatsnew (pandas-dev#24453)
  DOC: Add dateutil to intersphinx pandas-dev#24437 (pandas-dev#24443)
  DOC: Adding links to offset classes in timeseries.rst (pandas-dev#24448)
  DOC: Adding offsets to API ref (pandas-dev#24446)
  DOC: fix flake8 issue in groupby.rst (pandas-dev#24363)
  DOC: Fixing more doc warnings (pandas-dev#24438)
  API: Simplify repeat signature (pandas-dev#24447)
  BUG: to_datetime(Timestamp, utc=True) localizes to UTC (pandas-dev#24441)
  CLN: Cython Py2/3 Compatible Imports (pandas-dev#23940)
  DOC: Fixing more doc warnings (pandas-dev#24431)
  DOC: Removing old release.rst (pandas-dev#24427)
  BUG-24408 Series.dt does not maintain own copy of index (pandas-dev#24426)
  DOC: Fixing several doc warnings (pandas-dev#24430)
  ENH: fill_value argument for shift pandas-dev#15486 (pandas-dev#24128)
  ...
Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019
@benjaminr @Pingviinituutti
DOC: Add dateutil to intersphinx pandas-dev#24437 (pandas-dev#24443)
1a03f80
Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019
@benjaminr @Pingviinituutti
DOC: Add dateutil to intersphinx pandas-dev#24437 (pandas-dev#24443)
9736a37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@datapythonista datapythonista datapythonista approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
0.24.0
Development

Successfully merging this pull request may close these issues.

DOC: Add dateutil to intersphinx
3 participants
@benjaminr @datapythonista @jreback