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

Alexandre Abadie notifications at github.com
Wed Mar 6 14:22:18 CET 2019


aabadie commented on this pull request.

Looks good in general. I ran tox locally and it works. I have small comments though.

>                                       [--jobs JOBS]
                                      riot_directory board [result_directory]
 
 positional arguments:
   riot_directory        RIOT directory to test
   board                 Board to test
-  result_directory      Result directory, by default "results"
+  result_directory      Result directory, by default "results" (default:

the `by default "results"` is redundant with `(default: results)`.

>  
 optional arguments:
   -h, --help            show this help message and exit
   --applications APPLICATIONS
                         List of applications to test, overwrites default
-                        configuration of testing all applications
+                        configuration of testing all applications (default:
+                        None)

Since you are disabling line length check with flake8 for the docstring, maybe put `(default: None)` on the same line.
Same for `loglevel` option.

Well, I tested putting the `default: None` on the same line locally and it breaks the test. After more tries, it seems that the test comparison is rather fragile regarding the comparison of the help message with the docstring. The help message text can be wrapped differently for different output lengths. What is the default value ? Is it always the same ?


-- 
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#pullrequestreview-211216001
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190306/e5ce0752/attachment-0001.html>


More information about the notifications mailing list