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

Improve documentation of examples for GenericStorage with Investment #1023

Open
wants to merge 5 commits into
base: dev
Choose a base branch
from

Conversation

lensum
Copy link
Contributor

@lensum lensum commented Nov 24, 2023

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

Closes #1022

@pep8speaks
Copy link

pep8speaks commented Dec 14, 2023

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! 🍻

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

@lensum lensum changed the title Draft: Improve documentation of examples for GenericStorage with Investment Improve documentation of examples for GenericStorage with Investment Dec 19, 2023
@lensum
Copy link
Contributor Author

lensum commented Dec 19, 2023

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 #1013).

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

Successfully merging this pull request may close these issues.

Improve documentation of examples for GenericStorage with Investment
3 participants