FlexMeasures / flexmeasures / 22140373715

78%

push

github

Docs/commitments section (#1849)

* docs: new section describing commitments

Signed-off-by: F.N. Claessen <felix@seita.nl>

* docs: rewrite the overview in commitments section

Signed-off-by: F.N. Claessen <felix@seita.nl>

* docs: keep ems variables, but explain them as representing the site context

Signed-off-by: F.N. Claessen <felix@seita.nl>

* docs: cross-reference the commitments section and the linear problem formulation

Signed-off-by: F.N. Claessen <felix@seita.nl>

* fix: cross-references

Signed-off-by: F.N. Claessen <felix@seita.nl>

* docs: add commitments section to index

Signed-off-by: F.N. Claessen <felix@seita.nl>

* docs: changelog entry

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* docs: update commitments section after review

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* docs: remove developer example

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* docs: move grouping section

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* docs: fix typo

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* docs: fix code-block formatting

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* docs: add note about UI support

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* docs: fix example json

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* docs: put value first for better legibility without horizontal scrolling

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* docs: use info icon for admonition (_static/css/custom_css has custom styling for this)

Signed-off-by: F.N. Claessen <claessen@seita.nl>

* improve intro and a few other sentences

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* two more clarifications in intro and in a note about how to edit commitments

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* small change to headings

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* slight improvement of the grouping discussion

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

---------

Signed-off-... (continued)

1613 of 2137 branches covered (75.48%)

Branch coverage included in aggregate %.

11178 of 14326 relevant lines covered (78.03%)

4.68 hits per line