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.

Sign up for GitHub

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

Jump to bottom

Add descriptive comments to all public functions #234

Open
kaimast opened this issue Apr 23, 2024 · 0 comments
Open

Add descriptive comments to all public functions #234

kaimast opened this issue Apr 23, 2024 · 0 comments
Labels
documentation

Comments

@kaimast
Copy link
Collaborator

kaimast commented Apr 23, 2024

Every public function in the codebase should have a proper documentation. Currently, this is not the case and the associated lint is disabled.
In particular, the following entry disables the check for it

[rule.package-comments]
    Disabled = true
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kaimast