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

Update docstrings for new functions #23

Open
nsryan2 opened this issue Sep 20, 2021 · 0 comments
Open

Update docstrings for new functions #23

nsryan2 opened this issue Sep 20, 2021 · 0 comments
Labels
Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:3-Desired This work is important, but not urgent. Status:1-New No one has claimed this issue yet. It is in need of solving. Type:Docs Is related to API documentation, website content, etc.

Comments

@nsryan2
Copy link
Member

nsryan2 commented Sep 20, 2021

Some functions, like set_distribution in commodity.py or add_regional_data in technology.py have increased capability due to new arguments, and need to have their parameters and returns updated.

We are following the numpy style of docstrings, so please add the components inputs, returns, and descriptions.

If you are unsure what a function does, feel free to ask!

Edit: This isn't a comprehensive list, but there are also some in db_creator.py like create_lifetime_tech

@nsryan2 nsryan2 added Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:3-Desired This work is important, but not urgent. Status:1-New No one has claimed this issue yet. It is in need of solving. Type:Docs Is related to API documentation, website content, etc. labels Sep 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:3-Desired This work is important, but not urgent. Status:1-New No one has claimed this issue yet. It is in need of solving. Type:Docs Is related to API documentation, website content, etc.
Projects
None yet
Development

No branches or pull requests

1 participant