Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Dunder methods #3926

Closed
Bibo-Joshi opened this issue Oct 9, 2023 · 0 comments · Fixed by #3929
Closed

[Documentation] Dunder methods #3926

Bibo-Joshi opened this issue Oct 9, 2023 · 0 comments · Fixed by #3929
Assignees

Comments

@Bibo-Joshi
Copy link
Member

Follow-up of #3907.

It should be double checked where we have dunder/magic methods of public classes that do not have a proper docstring yet. On first glance, I saw Bot.__{eq, hash}__ as well as some methods in the __error__ module.
These methods should get descriptive docstrings (even if it's just pointing to the base class) with argument descriptions where applicable.

Moreover, the :special-members: directives can be removed everywhere in the .rst files.

@clot27 clot27 self-assigned this Oct 12, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Dec 18, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants