Skip to content

DOC: avoid warnings ipython 'Code input with no code' #24238

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

jorisvandenbossche
Copy link
Member

Need to check in the doc build log if this actually solves some of the warnings like

/home/travis/miniconda3/envs/pandas-dev/lib/python3.6/site-packages/IPython/sphinxext/ipython_directive.py:1020: UserWarning: Code input with no code at /home/travis/build/pandas-dev/pandas/doc/source/whatsnew/v0.24.0.rst, line 304

@datapythonista one annoying thing with the included {{ header }} is that the reported line numbers no longer are correct ...

@codecov
Copy link

codecov bot commented Dec 11, 2018

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #24238   +/-   ##
=======================================
  Coverage   92.21%   92.21%           
=======================================
  Files         162      162           
  Lines       51763    51763           
=======================================
  Hits        47733    47733           
  Misses       4030     4030
Flag Coverage Δ
#multiple 90.61% <ø> (ø) ⬆️
#single 43% <ø> (ø) ⬆️

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 f6c7f6b...644842a. Read the comment docs.

1 similar comment
@codecov
Copy link

codecov bot commented Dec 11, 2018

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #24238   +/-   ##
=======================================
  Coverage   92.21%   92.21%           
=======================================
  Files         162      162           
  Lines       51763    51763           
=======================================
  Hits        47733    47733           
  Misses       4030     4030
Flag Coverage Δ
#multiple 90.61% <ø> (ø) ⬆️
#single 43% <ø> (ø) ⬆️

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 f6c7f6b...644842a. 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.

lgtm (didn't check the logs)

Seems like the {header} is creating several problems, but I think the only alternative is having the same statements at the beginning of each file, and in my opinion that is worse than the problems so far. Any other idea?

@jorisvandenbossche jorisvandenbossche merged commit 01afc42 into pandas-dev:master Dec 13, 2018
@jorisvandenbossche jorisvandenbossche deleted the doc-empty-ipython branch December 13, 2018 17:00
@jorisvandenbossche
Copy link
Member Author

jorisvandenbossche commented Dec 13, 2018

Seems like the {header} is creating several problems, but I think the only alternative is having the same statements at the beginning of each file, and in my opinion that is worse than the problems so far. Any other idea?

No, not really another idea. It's indeed duplicated content, but on the other hand, also some lines that are hardly ever touched I think. So personally I don't think that this duplication is that of a problem.
I can just say that fixing warnings of sphinx is annoying in general, having the line numbers not match up is not making it better :-)

@datapythonista
Copy link
Member

Absolutely agree. Will see if I can monkeypatch sphinx. I'm finishing a PR to build a single documentation page faster, and fail if it has warnings, so we can start fixing them in an efficient way. So would be great to have the line numbers matching, as we'll have to fix plenty of them.

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.

2 participants