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-strings to ported code #79

Open
dpsimpson opened this issue Oct 21, 2024 · 0 comments
Open

Add doc-strings to ported code #79

dpsimpson opened this issue Oct 21, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@dpsimpson
Copy link
Contributor

What behavior of the library made you think about the improvement?

This library is very light on doc-strings, which isn't ideal for people getting into the code base (and isn't good practice anyway).

How would you like it to behave?

Every function should have at least a basic docstring, having

  • Inputs
  • Outputs
  • Purpose / Usage (if complex) / High-level method (if complex)
@dpsimpson dpsimpson added the enhancement New feature or request label Oct 21, 2024
@rlouf rlouf assigned torymur and unassigned torymur Oct 23, 2024
@torymur torymur self-assigned this Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants