iobis / pyobis

OBIS Python client

https://iobis.github.io/pyobis

MIT License

14 stars 10 forks source link

[update] Docs Update after feature upgrade + changelog update #79

Closed ayushanand18 closed 2 years ago

ayushanand18 commented 2 years ago

Overview

This PR aims to bring necessary updates to docs after the recent feature upgrade (response class introduction).

Summary of changes

all docs and examples have been updated, including docstrings.
changelog has also been updated.
version incremented after feature upgrade.

Questions for reviewers

Just a minor doubt, should we update the copyright year as in docs to 2016-2022? This might signify that the package has been updated and is being maintained.

Next objectives

I am now working on updating the notebooks, and I'll bring another PR for it.

7yl4r commented 2 years ago

Just a minor doubt, should we update the copyright year as in docs to 2016-2022? This might signify that the package has been updated and is being maintained.

I don't know of any reason not to. I don't know the legal details of why date ranges are included alongside the copyright notice though.

ayushanand18 commented 2 years ago

Thank you so much for the review! I am sorry for those spelling mistakes, I'm really bad at my grammar :)

Should I update the year range in this PR?

7yl4r commented 2 years ago

Should I update the year range in this PR?

I made a change to the LICENSE and conf.py. Does that look good?

ayushanand18 commented 2 years ago

Looks great. If we are changing the LICENSE, should we change the setup.cfg also now?