[FEA] Move pandas-related notes from Notes to pandas-compat

[vyasr]

Is your feature request related to a problem? Please describe.
#8643 introduced a new rST directive pandas-compat to our documentation that allows us to collect all documentation relating to differences between cuDF methods and pandas methods. That directive enables us to much more effectively indicate to users when our behavior differs from pandas. However, we have not since made much use of this directive. Many docstrings still contain Notes sections that are essentially just descriptions of how a class/function/method differs from pandas.

Describe the solution you'd like
We should convert all pandas-related Notes sections of docstrings into pandas-compat sections. Doing so should be quite straightforward by simply searching for the header Notes in all files containing public APIs. For examples on how to use the pandas-compat directive, see #8643.

Describe alternatives you've considered
None

Additional context
There are likely many other places where we differ from pandas that are either 1) undocumented or 2) documented in different ways. We should also aim to improve that documentation. However, that is a nebulous target since it's not immediately clear where all those places are, so this issue is just focusing on the more specific goal of replacing Notes sections, which can be easily searched for and replaced as needed.

[Touutae-lab]

I would like to help this issues.

[shwina]

Hi @Touutae-lab -- thanks for your interest in contributing! This would absolutely be a welcome addition to cuDF. Please feel free to comment here if you need any help as you work on this issue.

[Touutae-lab]

BUG Report

@shwina
can't convert Note froms DataFrame.mode

convert to

Extension error (numpydoc.numpydoc):
Handler <function mangle_signature at 0x7fe25c23d630> for event 'autodoc-process-signature' threw an exception (exception: Error parsing See Also entry '.. pandas-compat::' in the docstring of mode in /home/touutae/miniconda3/envs/cudf_dev/lib/python3.10/contextlib.py.)
make: *** [Makefile:20: html] Error 2

it only happened when edited DataFrame.mode

[Touutae-lab]

@shwina
Hi,
I already working on some that i can convert can you check please ?

[vyasr]

This was completed in #12641