Skip to content

Commit

Permalink
style: rephrase changelog entries
Browse files Browse the repository at this point in the history
Signed-off-by: F.N. Claessen <felix@seita.nl>
  • Loading branch information
Flix6x committed Jan 11, 2024
1 parent d04bc82 commit 15397bc
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
2 changes: 1 addition & 1 deletion documentation/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Infrastructure / Support
----------------------

* Deprecate use of flask's ``FLASK_ENV`` variable and replace it with ``FLEXMEASURES_ENV`` [see `PR #907 <https://github.com/FlexMeasures/flexmeasures/pull/907>`_]
* Deprecate ``--account-id``, ``--asset-id``, ``--asset-type-id``, ``--sensor-id``, ``--source-id`` and ``--user-id`` cli options. Instead use ``--account``, ``--asset``, ``--asset-type``, ``--sensor``, ``--source`` and ``--user`` options, respectively [see `PR #946 <https://github.com/FlexMeasures/flexmeasures/pull/946>`_]
* Streamline CLI option naming by favoring ``--<entity>`` over ``--<entity>-id`` [see `PR #946 <https://github.com/FlexMeasures/flexmeasures/pull/946>`_]


Bugfixes
Expand Down
9 changes: 8 additions & 1 deletion documentation/cli/change_log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,14 @@ FlexMeasures CLI Changelog
since v0.19.0 | February xx, 2024
=======================================

* Deprecate ``--account-id``, ``--asset-id``, ``--asset-type-id``, ``--sensor-id``, ``--source-id`` and ``--user-id`` cli options. Instead use ``--account``, ``--asset``, ``--asset-type``, ``--sensor``, ``--source`` and ``--user`` options, respectively.
* Streamline CLI option naming by favoring ``--<entity>`` over ``--<entity>-id``. This affects the following options:

* ``--account-id`` -> ``--account``
* ``--asset-id`` -> ``--asset``
* ``--asset-type-id`` -> ``--asset-type``
* ``--sensor-id`` -> ``--sensor``
* ``--source-id`` -> ``--source``
* ``--user-id`` -> ``--user`
since v0.17.0 | November 8, 2023
Expand Down

0 comments on commit 15397bc

Please sign in to comment.