DOC: Docstring for BooleanDType inconsistent with the rest of repo #61939
Description
Pandas version checks
- I have checked that the issue still exists on the latest versions of the docs on
mainhere
Location of the documentation
https://github.com/pandas-dev/pandas/blob/main/pandas/core/arrays/boolean.py
Documentation problem
The docstring for the class BooleanDType has very little information about the functionality of the class.
"""
Extension dtype for boolean data.
.. warning::
BooleanDtype is considered experimental. The implementation and
parts of the API may change without warning.
Attributes
----------
None
Methods
-------
None
See Also
--------
StringDtype : Extension dtype for string data.
Examples
--------
>>> pd.BooleanDtype()
BooleanDtype
"""
What pieces of the docstring are included are sparse, and there is no parameters section included. In order to understand anything that the class is used for, I have to read through the code, which defeats the purpose of having the docstring. I read through the other class in the file and its docstring is far more developed and had a multi sentence summary of the classes uses, a parameters section and examples that used example data to convey a use case.
Suggested fix for documentation
I suggest that somebody find what parameters are being used and add a section for them. Also, that a more specific example section be added and that the summary section be extended to include more description of the class's function.
I would be happy to start remedying these problems.