Fix storage and investment storage block docstrings #735
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
uvchik
reviewed
Feb 12, 2021
| (InvestmentFlow.invest(n, target(n)) + existing) * \\ | ||
| invest\_relation\_input\_output(n) \\ | ||
| \forall n \in \textrm{INVEST\_REL\_IN\_OUT} | ||
|
|
There was a problem hiding this comment.
I would not remove it from the docs, because this constraint exists. There should be more information added. Something like "In case invest_relation_input_output is set (or not None)`, the following constraint is build:"
|
PR relates to issue #734 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes (hopefully) minor errors in the doc of the GenericStorageBlock and GenericStorageInvementBlock docstring.