Skip to content

DOC: add missing links to introduction to pandas #32198

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 3 commits into from
Feb 27, 2020
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
23 changes: 11 additions & 12 deletions doc/source/getting_started/10min.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ and labeled columns:
df = pd.DataFrame(np.random.randn(6, 4), index=dates, columns=list('ABCD'))
df

Creating a ``DataFrame`` by passing a dict of objects that can be converted to series-like.
Creating a :class:`DataFrame` by passing a dict of objects that can be converted to series-like.

.. ipython:: python

Expand All @@ -51,7 +51,7 @@ Creating a ``DataFrame`` by passing a dict of objects that can be converted to s
'F': 'foo'})
df2

The columns of the resulting ``DataFrame`` have different
The columns of the resulting :class:`DataFrame` have different
:ref:`dtypes <basics.dtypes>`.

.. ipython:: python
Expand Down Expand Up @@ -169,7 +169,7 @@ See the indexing documentation :ref:`Indexing and Selecting Data <indexing>` and
Getting
~~~~~~~

Selecting a single column, which yields a ``Series``,
Selecting a single column, which yields a :class:`Series`,
equivalent to ``df.A``:

.. ipython:: python
Expand Down Expand Up @@ -469,10 +469,10 @@ Concatenating pandas objects together with :func:`concat`:
pd.concat(pieces)

.. note::
Adding a column to a ``DataFrame`` is relatively fast. However, adding
Adding a column to a :class:`DataFrame` is relatively fast. However, adding
a row requires a copy, and may be expensive. We recommend passing a
pre-built list of records to the ``DataFrame`` constructor instead
of building a ``DataFrame`` by iteratively appending records to it.
pre-built list of records to the :class:`DataFrame` constructor instead
of building a :class:`DataFrame` by iteratively appending records to it.
See :ref:`Appending to dataframe <merging.concatenation>` for more.

Join
Expand Down Expand Up @@ -520,15 +520,15 @@ See the :ref:`Grouping section <groupby>`.
'D': np.random.randn(8)})
df

Grouping and then applying the :meth:`~DataFrame.sum` function to the resulting
Grouping and then applying the :meth:`~pandas.core.groupby.GroupBy.sum` function to the resulting
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the tilde required here? Can you build this to see how this currently renders?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are no problems when I build the documentation locally. But when I pushed it to pandas-dev, some tests failed (previous commit). However, after I added tilde, all checks passed. I thought it might be because the link was displayed as pandas.core.groupby.GroupBy.sum() instead of sum().

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it actually render the link? This is different than how we link to GroupBy methods in our what’s new so not sure this would really solve the problem at hand (could be wrong)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

iirc the tilde is used to just print the last element in the link text. So, without the tilde the text link would be pandas.core.groupby.GroupBy.sum, and with the tilde should be just sum.

I don't think the doc build should fail in any of the cases. May be the error was something else?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it actually render the link?

Yes, it does render the link with and without the tilde.

iirc the tilde is used to just print the last element in the link text

Yes, it is correct. In the last commit the link is displayed as sum() instead of pandas.core.groupby.GroupBy.sum.

I don't think the doc build should fail in any of the cases. May be the error was something else?

I checked today locally, there were no problems with building of the documentation, so the error might be not related.

Should I push it without tilde? Or should I leave it like it is?

groups.

.. ipython:: python

df.groupby('A').sum()

Grouping by multiple columns forms a hierarchical index, and again we can
apply the ``sum`` function.
apply the :meth:`~pandas.core.groupby.GroupBy.sum` function.

.. ipython:: python

Expand Down Expand Up @@ -648,7 +648,7 @@ the quarter end:
Categoricals
------------

pandas can include categorical data in a ``DataFrame``. For full docs, see the
pandas can include categorical data in a :class:`DataFrame`. For full docs, see the
:ref:`categorical introduction <categorical>` and the :ref:`API documentation <api.arrays.categorical>`.

.. ipython:: python
Expand All @@ -664,14 +664,13 @@ Convert the raw grades to a categorical data type.
df["grade"]

Rename the categories to more meaningful names (assigning to
``Series.cat.categories`` is inplace!).
:meth:`Series.cat.categories` is inplace!).

.. ipython:: python

df["grade"].cat.categories = ["very good", "good", "very bad"]

Reorder the categories and simultaneously add the missing categories (methods under ``Series
.cat`` return a new ``Series`` by default).
Reorder the categories and simultaneously add the missing categories (methods under :meth:`Series.cat` return a new :class:`Series` by default).

.. ipython:: python

Expand Down