doc: update ChangeTable docstrings #451
Conversation
powersimdata/input/change_table.py
Outdated
| Required keys: "bus_id", "Pmax", "type". | ||
| Optional keys: "c0", "c1", "c2", "Pmin". | ||
| "c0", "c1", and "c2" are the coefficients for the cost curve, representing | ||
| the fixed cost ($/hour), linear cost ($/MWh), and quadratic cost ($/MW^2*h). |
There was a problem hiding this comment.
Do you want formatting on the quadratic term only, or all of them?
There was a problem hiding this comment.
Will it change for the other ones? the exponent in the quadratic is the on;y thing that will be in math mode
There was a problem hiding this comment.
First time see this representation. This is the classic way to represent the unit of the quadratic term?
There was a problem hiding this comment.
@rouille: Ah, I get it now. I didn't realize that \rm{} completely undid the 'math-style' formatting, or if it just de-italicized or something similar like that (like \text). Clever!.
There was a problem hiding this comment.
:math: in ReST lets you right some LaTeX math
There was a problem hiding this comment.
@BainanXia I'm not sure. I think removing the * per @rouille's suggestion will make it clear. The units line up properly.
powersimdata/input/change_table.py
Outdated
| Optional keys: "c0", "c1", "c2", "Pmin". | ||
| "c0", "c1", and "c2" are the coefficients for the cost curve, representing | ||
| the fixed cost ($/hour), linear cost ($/MWh), and quadratic cost ($/MW^2*h). | ||
| These are optional for hydro, solar, and wind, and required for other types. | ||
| :raises TypeError: if info is not a list. |
There was a problem hiding this comment.
With one ` or two on each side?
There was a problem hiding this comment.
two on each side for verbatim (it displays like that) in ReST. I started to reference to parameters in the docstring this way as we do in Slack or Markdown
powersimdata/input/change_table.py
Outdated
| "terminal_min" denotes the minimum state of charge at interval end, | ||
| e.g. 0.5 means that the storage must end the interval with at least 50%. | ||
| "terminal_max" denotes the maximum state of charge at interval end, | ||
| e.g. 0.9 means that the storage must end the interval with no more than 90%. | ||
| :raises TypeError: if info is not a list. |
Purpose
Add details to the docstrings of the ChangeTable methods for adding new elements, and update the main ChangeTable docstring to more accurately reflect the new storage schema (clean-up after #383).
Closes #445.
What the code is doing
No code, just docstrings.
Time estimate
5-10 minutes.