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

Would adding docstrings to functions be a welcome PR? #336

Open
JSorngard opened this issue Oct 28, 2024 · 2 comments
Open

Would adding docstrings to functions be a welcome PR? #336

JSorngard opened this issue Oct 28, 2024 · 2 comments

Comments

@JSorngard
Copy link
Contributor

I notice that a lot of the functions don't have a docstring that shows up on docs.rs, but there is information available in comments in the implementation. Would it be welcome if I made a PR where I add docstrings to some more functions?
@JSorngard
Copy link
Contributor Author

JSorngard commented Oct 28, 2024 •
edited
Loading

And if so, should they contain anything beyond a basic description of the function?

@tgross35
Copy link
Contributor

Sure! A short description is totally fine, maybe with a link to the wikipedia page for anything less trivial.

This was referenced Oct 28, 2024
Merged
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tgross35 @JSorngard