DOC: add missing links to introduction to pandas #32198
Conversation
doc/source/getting_started/10min.rst
Outdated
| Grouping by multiple columns forms a hierarchical index, and again we can | ||
| apply the ``sum`` function. | ||
| apply the :meth:`~DataFrame.sum` function. |
There was a problem hiding this comment.
this is not correct, you need:: meth:`pandas.core.groupby.GroupBy.sum`
| 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 |
There was a problem hiding this comment.
Is the tilde required here? Can you build this to see how this currently renders?
There was a problem hiding this comment.
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().
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?
datapythonista
left a comment
datapythonista
left a comment
There was a problem hiding this comment.
Regardless of the tilde discussion, this looks like a nice improvement, happy to get this merged either way.
| 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 |
There was a problem hiding this comment.
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?
|
Thanks @raisadz |
4 participants
I noticed that there were some links missing in `10 minutes to pandas'.