Description
There's a docstring section called See Also, which links to docs pages of related objects. For example:
Is your feature request aligned with the scope of the package?
Describe the solution you'd like, or your current workaround.
This is a Sphinx directive, so all you have to do is label the "See Also" section, just like you would with "Parameters", and write down the name of the object and a summary description:
class Series:
def head(self):
"""
Return the first 5 elements of the Series.
This function is mainly useful to preview the values of the
Series without displaying the whole of it.
Returns
-------
Series
Subset of the original series with the 5 first values.
See Also
--------
Series.tail : Return the last 5 elements of the Series.
Series.iloc : Return a slice of the elements in the Series,
which can also be used to return the first or last n.
"""
return self.iloc[:5]
Then the docs will automatically render this box with the links to the related pages.
Do you have any additional supporting notes?
This is a good issue we can farm out for people who want some easy contribution credits. It does not have to be perfect, and nor do the summary descriptions have to match those of the docstrings they link to. Pandas is not 100% consistent in this regard either.
As long as it can help people navigate the docs better, it's useful.
Would you be willing to contribute this ticket?
Description
There's a docstring section called
See Also, which links to docs pages of related objects. For example:Is your feature request aligned with the scope of the package?
Describe the solution you'd like, or your current workaround.
This is a Sphinx directive, so all you have to do is label the "See Also" section, just like you would with "Parameters", and write down the name of the object and a summary description:
Then the docs will automatically render this box with the links to the related pages.
Do you have any additional supporting notes?
This is a good issue we can farm out for people who want some easy contribution credits. It does not have to be perfect, and nor do the summary descriptions have to match those of the docstrings they link to. Pandas is not 100% consistent in this regard either.
As long as it can help people navigate the docs better, it's useful.
Would you be willing to contribute this ticket?