-
Notifications
You must be signed in to change notification settings - Fork 34
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
Shortened CLI option names and updated corresponding tests #946
Conversation
Signed-off-by: Ahmad Wahid <ahmedwahid16101@gmail.com>
Signed-off-by: Ahmad Wahid <ahmedwahid16101@gmail.com>
Signed-off-by: Ahmad Wahid <ahmedwahid16101@gmail.com>
Don't forget the Issue comment about nicely deprecating the old CLI options. That means they should keep working like before, while giving a deprecating notice. Furthermore, the new CLI option should use available schemas for sensor IDs and source IDs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm guessing parts of the documentation should be updated, too.
okay. |
Signed-off-by: Ahmad Wahid <ahmedwahid16101@gmail.com>
Signed-off-by: Ahmad Wahid <ahmedwahid16101@gmail.com>
Should I add these changes to the cli changelog? |
Signed-off-by: Ahmad Wahid <ahmedwahid16101@gmail.com>
Yes, and also to the main changelog. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also adapt the small example in documentation/index.rst
please.
Signed-off-by: Ahmad Wahid <ahmedwahid16101@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
I found some leftover sensor-id
references in the documentation:
-
flexmeasures/flexmeasures/cli/data_add.py
Line 995 in a4f0b30
--from-date 2015-02-02 --to-date 2015-02-04 --horizon 6 --sensor-id 12 --sensor-id 14 -
flexmeasures/documentation/index.rst
Line 43 in a4f0b30
$ flexmeasures add beliefs --sensor-id 2 --source toy-user prices-tomorrow.csv --timezone utc # load prices, also possible per API -
$ flexmeasures add schedule for-storage --sensor-id 2 --consumption-price-sensor 1 \ -
$ docker exec -it flexmeasures-server-1 bash -c "flexmeasures show beliefs --sensor-id 2 --start ${TOMORROW}T07:00:00+01:00 --duration PT12H"
Signed-off-by: Ahmad Wahid <ahmedwahid16101@gmail.com>
After the change in |
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The parameter alias deprecation works nicely. I have two small improvement suggestions, and would like to see proper attribution on SO content.
…-names # Conflicts: # documentation/cli/change_log.rst
Signed-off-by: Ahmad Wahid <ahmedwahid16101@gmail.com>
Signed-off-by: Ahmad Wahid <ahmedwahid16101@gmail.com>
Signed-off-by: Ahmad Wahid <ahmedwahid16101@gmail.com>
Signed-off-by: Ahmad Wahid <ahmedwahid16101@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉
Within this pull request, I've reduced the length of the CLI option names and modified the associated tests accordingly. For instance,
--sensor-id
has been changed to--sensor
,--account-id
is now--account
, and--user-id
has been updated to--user
, etc.