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 docstrings to all functions in SDG build #204

Open
jwestw opened this issue Feb 17, 2021 · 1 comment
Open

Add docstrings to all functions in SDG build #204

jwestw opened this issue Feb 17, 2021 · 1 comment

Comments

@jwestw
Copy link

jwestw commented Feb 17, 2021

While some of the functions are very well documented in docstrings, others are not at all.

I suggest I go through and make docstrings for all of them, in line with best practice.

This is something I could do, though I would probably need clarification sometimes.

@brockfanning
Copy link
Contributor

This sounds good to me. I would love to eventually get some sort of automated documentation going. I've never tried that with Python, but I guess it relies on some sort of a standard approach to these docstrings?

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

No branches or pull requests

2 participants