[riot-notifications] [RIOT-OS/RIOT] tools/compile_and_test_for_board: FIX outdated help docstring (#11079)

Gaƫtan Harter notifications at github.com
Thu Feb 28 13:48:56 CET 2019


### Contribution description

Update the help message in the docstring.
It should reflect the content of `--help`.

I replaced the manual line wrapping by disabling the warning on the
docstring.

This pull requests also add a `tests` directory and a test to verify it is up to date.

### Testing procedure

```
cd dist/tools/compile_and_test_for_board
tox
```

The test suite should work, and the `Usage` string in the docstring should reflect the output of `./compile_and_test_for_board.py --help`.

Modifying the usage string should show an error.

### Issues/PRs references

I found the issue while reviewing and working on https://github.com/RIOT-OS/RIOT/pull/10838

You can view, comment on, or merge this pull request online at:

  https://github.com/RIOT-OS/RIOT/pull/11079

-- Commit Summary --

  * tools/compile_and_test_for_board: FIX outdated help docstring
  * tools/compile_and_test_for_board: add tests for help message
  * tools/compile_and_test_for_board: add tests directory

-- File Changes --

    M dist/tools/compile_and_test_for_board/compile_and_test_for_board.py (30)
    A dist/tools/compile_and_test_for_board/tests/__init__.py (0)
    A dist/tools/compile_and_test_for_board/tests/test_compile_and_test_for_board.py (18)
    M dist/tools/compile_and_test_for_board/tox.ini (6)

-- Patch Links --

https://github.com/RIOT-OS/RIOT/pull/11079.patch
https://github.com/RIOT-OS/RIOT/pull/11079.diff

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/RIOT-OS/RIOT/pull/11079
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190228/a631618b/attachment.html>


More information about the notifications mailing list