oemof-solph icon indicating copy to clipboard operation
oemof-solph copied to clipboard

Improve documentation of examples for GenericStorage with Investment

Open lensum opened this issue 1 year ago • 2 comments

This PR should provide a few adjustments to the inline documentation of the GenericInvestmentStorage usage.

Closes #1022

lensum avatar Nov 24 '23 08:11 lensum

Hello @lensum! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! :beers:

Comment last updated at 2023-12-14 10:50:23 UTC

pep8speaks avatar Dec 14 '23 09:12 pep8speaks

There could probably be more examples, especially on how to use the Investment object with the storage. However, I think the GenericInvestmentStorage needs an overhaul before preparing examples on the usage (see https://github.com/oemof/oemof-solph/issues/1013).

lensum avatar Dec 19 '23 16:12 lensum