Skip to content

DOC: added "How to read these guides" section to User Guide page (#39130) #46120

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
Feb 23, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions doc/source/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,43 @@ For a high level summary of the pandas fundamentals, see :ref:`dsintro` and :ref
Further information on any specific method can be obtained in the
:ref:`api`.

How to read these guides
------------------------
In these guides you will see input code inside code blocks such as:

::

import pandas as pd
pd.DataFrame({'A': [1, 2, 3]})


or:

.. ipython:: python

import pandas as pd
pd.DataFrame({'A': [1, 2, 3]})

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.

For example:

.. ipython:: python

a = 1
a
is equivalent to:

::

a = 1
print(a)



Guides
-------

.. If you update this toctree, also update the manual toctree in the
main index.rst.template

Expand Down