DOC: Docstrings missing from .py files in Sphinxext docs folder

[shindelr]

Pandas version checks

• I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://github.com/pandas-dev/pandas/blob/main/doc/sphinxext/contributors.py
https://github.com/pandas-dev/pandas/blob/main/doc/sphinxext/announce.py

Documentation problem

Both announce.py and contributors.py are missing the class and function docstrings encouraged by Pandas documentation. There are around 5 functions and 1 class that need documenting. Docstrings are always helpful for new users looking to contribute to the codebase.

Suggested fix for documentation

The docs have a detailed docstring how-to guide:
https://pandas.pydata.org/docs/dev/development/contributing_docstring.html

[Aloqeely]

Thanks for the suggestion. Ideally, we would want to have docstrings for every function, but I think it's more beneficial to write docstrings for the public pandas methods over these internal scripts.

Feel free to submit a PR to add the docstrings, but we also have open issues for improving the public documentation (such as #58065), and would appreciate your help on these issues instead

[42bismuth]

I'm new to open source but interested in tackling this issue! Happy to learn and contribute. Can I take this on?

[Aloqeely]

Can I take this on?

Of course!

[anishfish2]

Hi! New to open source and just wondering what the progress was on this issue?

[MrF1ow]

Hello, I was wondering if I could tackle this as well?

[Aloqeely]

Hey @anishfish2 and @MrF1ow, thanks for the interest but there is already someone working on this issue. Happy to have your help on other issues with the Docs label though!

[sumwun1]

If someone's already working on it, can they assign the issue to themself? That would make it easier for the rest of us to find unassigned issues.