The Azure IoT Edge Dev Tool greatly simplifies your Azure IoT Edge development process. It has everything you need to get started and helps with your day-to-day Edge development.
This checklist is used to make sure that common guidelines for a pull request are followed.
[ ] Versions update reflected in all places (both init.py files, CHANGELOG, setup.py, setup.cfg)
[ ] Unit tests pass locally
[ ] Quickstart steps locally validated
[ ] Passes unit tests in CICD pipeline (green on Github pipeline)
[ ] Pypi RC version passes Edge CICD pipeline validation for cross-tool validation
[ ] Pull request includes test coverage for the included changes
[ ] Documentation is updated for the included changes
General guidelines
[x] Title of the pull request is clear and informative.
[x] There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR.
Description
Fixes #592
This PR adds a message to each deprecated command to show the newly recommended command, but for the short_help (iotedgedev --help) and the extended help (iotedgedev <command> --help).
It does this by adding an additional flag to the add_command_with_deprecation method to pass in the alternative command.
Additionally, the method sanity checks the short_help and ensures it is set.
Checklist
This checklist is used to make sure that common guidelines for a pull request are followed.
General guidelines
Description
Fixes #592
This PR adds a message to each deprecated command to show the newly recommended command, but for the short_help (
iotedgedev --help
) and the extended help (iotedgedev <command> --help
). It does this by adding an additional flag to theadd_command_with_deprecation
method to pass in the alternative command. Additionally, the method sanity checks theshort_help
and ensures it is set.