Skip to content

Commit e7d6846

Browse files
authored
DOC: added "How to read these guides" section to User Guide page (#39130) (#46120)
Based on changes by rhuille <[email protected]>
1 parent 70aabc6 commit e7d6846

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

doc/source/user_guide/index.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,43 @@ For a high level summary of the pandas fundamentals, see :ref:`dsintro` and :ref
1717
Further information on any specific method can be obtained in the
1818
:ref:`api`.
1919

20+
How to read these guides
21+
------------------------
22+
In these guides you will see input code inside code blocks such as:
23+
24+
::
25+
26+
import pandas as pd
27+
pd.DataFrame({'A': [1, 2, 3]})
28+
29+
30+
or:
31+
32+
.. ipython:: python
33+
34+
import pandas as pd
35+
pd.DataFrame({'A': [1, 2, 3]})
36+
37+
The first block is a standard python input, while in the second the ``In [1]:`` indicates the input is inside a `notebook <https://jupyter.org>`__. In Jupyter Notebooks the last line is printed and plots are shown inline.
38+
39+
For example:
40+
41+
.. ipython:: python
42+
43+
a = 1
44+
a
45+
is equivalent to:
46+
47+
::
48+
49+
a = 1
50+
print(a)
51+
52+
53+
54+
Guides
55+
-------
56+
2057
.. If you update this toctree, also update the manual toctree in the
2158
main index.rst.template
2259

0 commit comments

Comments
 (0)