DoppelGANger icon indicating copy to clipboard operation
DoppelGANger copied to clipboard

Docstrings in DoppelGANger

Open loehndorf opened this issue 6 years ago • 1 comments

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.

loehndorf avatar Nov 29 '19 21:11 loehndorf

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.

fjxmlzn avatar Nov 29 '19 23:11 fjxmlzn