DOC: Fixing more doc warnings #24438
Conversation
Codecov Report
@@ Coverage Diff @@
## master #24438 +/- ##
==========================================
+ Coverage 92.3% 92.31% +<.01%
==========================================
Files 163 163
Lines 51977 51977
==========================================
+ Hits 47979 47980 +1
+ Misses 3998 3997 -1
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #24438 +/- ##
=======================================
Coverage 92.3% 92.3%
=======================================
Files 163 163
Lines 51977 51977
=======================================
Hits 47979 47979
Misses 3998 3998
Continue to review full report at Codecov.
|
|
| @@ -1236,7 +1236,7 @@ the following Python code will read the binary file ``'binary.dat'`` into a | |||
| pandas ``DataFrame``, where each element of the struct corresponds to a column | |||
| in the frame: | |||
|
|
|||
| .. code-block:: python | |||
| .. ipython:: python | |||
There was a problem hiding this comment.
Is there a reason you changed this? As this doesn't run (there is no file binary.dat)
There was a problem hiding this comment.
I reverted it in #24552 (along with some other doc fixes), but we certainly can also try to actually fix the example (meaning: make it runnable).
There was a problem hiding this comment.
I found it inconsistent that everything had the ipython formatting and not this block (when rendered), and I thought code-block had to have the >>>, and that not being an ipython block was an error.
But it's ok to have them reverted. At least for now.
There was a problem hiding this comment.
It was indeed a bit strange to just include code without output (cookbook is not very well maintained anyhow).
We could in principle also include IPython like formatting in a code-block, if that makes it a bit more consistent.
| @@ -4879,7 +4879,7 @@ below and the SQLAlchemy `documentation <https://docs.sqlalchemy.org/en/latest/c | |||
|
|
|||
| If you want to manage your own connections you can pass one of those instead: | |||
|
|
|||
| .. code-block:: python | |||
| .. ipython:: python | |||
Follow up of #24430 and #24431. Addressing more doc warnings.
Also, forcing the docs Python code to be executed with the current directory
doc/, so no matter where the actual current directory, operations likepd.read_csv('data/baseball.csv')always work.