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

Docstrings in DoppelGANger #1

Open
loehndorf opened this issue Nov 29, 2019 · 1 comment
Open

Docstrings in DoppelGANger #1

loehndorf opened this issue Nov 29, 2019 · 1 comment

Comments

@loehndorf
Copy link

First of all. Thanks for the great work. I was able to use it to generate time series of natural inflows into water reservoirs, and it worked without much changes to the code.

It took me a while to figure out the right format though. I would have been much faster if the DoppelGANger class had proper Docstrings. I pretty much had to guess and try how the functions other than the constructor work. Providing some simple examples would also help.

@fjxmlzn
Copy link
Owner

fjxmlzn commented Nov 29, 2019

Glad to hear that it works for your application, and thanks for your suggestions!

We provided some simple examples in "example_*" folders. I will add more detailed docstrings and examples to the repo.

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