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

Add doc-stings to all public interfaces. #140

Closed
alexanderlazarev0 opened this issue Jan 11, 2025 · 2 comments
Closed

Add doc-stings to all public interfaces. #140

alexanderlazarev0 opened this issue Jan 11, 2025 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@alexanderlazarev0
Copy link
Collaborator

This can make it significantly simpler for users to use the package without having to always reference the documentation,
especially since the documentations is not guaranteed to be up-to-date.

Additionally: Enable the ruff check rule that checks if all public methods have an appropriate doc-string.

@alexanderlazarev0 alexanderlazarev0 added the documentation Improvements or additions to documentation label Jan 11, 2025
@alexanderlazarev0
Copy link
Collaborator Author

I kind of before suggested that we use reStructuredText / Sphinx doc strings, but have since noticed that they are extremely verbose compared to something like Google doc strings, perhaps we should switch?

@lesnik512
Copy link
Member

@alexanderlazarev0 I agree with switching to other format

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants