-
Notifications
You must be signed in to change notification settings - Fork 97
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
Copyright and licensing #40
Conversation
Accidentally uploaded.
atlite/__init__.py
Outdated
Renewable Energy Atlas Lite (Atlite) | ||
|
||
Light-weight version of Aarhus RE Atlas for converting weather data to power systems data | ||
""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you remove the package doc string intentionally? It is what is displayed, when you import the library. And then ask for help for it, ie
import atlite
?atlite
Instead I would like to extend it with a link to the documentation and perhaps one or two very simple examples.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, multiple reasons:
- Previous one was so out-of-date it was more confusing than helping.
- The docstring was repeated in every section of the API ref. generated by automodule on readthedocs.org - not something beautiful to look at.
- I didn't have a nice substitute.
I'd drop the examples (Pareto principle + we are working on nice examples in parallel). So I argue no need to open up a new frontier there IMHO.
Let's stick to a simple description, suggestion in the updated PR.
Thanks for that tedious work! Looks good and i would merge soonish, so that we do not pick up anymore conflicts! |
Happy to hear & you're welcome! |
I merged upstream into my local and resolved the merge conflicts. If you're ok with the result, then please push the button. :) |
I added new copyright and licensing information to all files and made
the repository (nearly) REUSE compliant.
Somehow some minor commits got mixed up in this PR (sorry, i don't want
make the effort of taking them out of this PR).
@coroa Please let me know if you agree with this.