Better document PYTEST_DONT_REWRITE docstring.

Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
ros2 · Aug 22, 2019 · c7e6f80 · c7e6f80
1 parent 0705777
commit c7e6f80
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 5 deletions.
diff --git a/launch_testing/launch_testing/asserts/assert_exit_codes.py b/launch_testing/launch_testing/asserts/assert_exit_codes.py
@@ -15,7 +15,9 @@
 """
 A module providing exit code assertions.
 
-PYTEST_DONT_REWRITE
+To prevent pytest from rewriting this module assertions, please PYTEST_DONT_REWRITE.
+See https://docs.pytest.org/en/latest/assert.html#disabling-assert-rewriting for
+further reference.
 """
 
 

diff --git a/launch_testing/launch_testing/asserts/assert_output.py b/launch_testing/launch_testing/asserts/assert_output.py
@@ -15,7 +15,9 @@
 """
 A module providing process output assertions.
 
-PYTEST_DONT_REWRITE
+To prevent pytest from rewriting this module assertions, please PYTEST_DONT_REWRITE.
+See https://docs.pytest.org/en/latest/assert.html#disabling-assert-rewriting for
+further reference.
 """
 
 

diff --git a/launch_testing/launch_testing/asserts/assert_sequential_output.py b/launch_testing/launch_testing/asserts/assert_sequential_output.py
@@ -15,7 +15,9 @@
 """
 A module providing process output sequence assertions.
 
-PYTEST_DONT_REWRITE
+To prevent pytest from rewriting this module assertions, please PYTEST_DONT_REWRITE.
+See https://docs.pytest.org/en/latest/assert.html#disabling-assert-rewriting for
+further reference.
 """
 
 

diff --git a/launch_testing/launch_testing/io_handler.py b/launch_testing/launch_testing/io_handler.py
@@ -15,7 +15,9 @@
 """
 A module providing process IO capturing classes.
 
-PYTEST_DONT_REWRITE
+To prevent pytest from rewriting this module assertions, please PYTEST_DONT_REWRITE.
+See https://docs.pytest.org/en/latest/assert.html#disabling-assert-rewriting for
+further reference.
 """
 
 

diff --git a/launch_testing/launch_testing/proc_info_handler.py b/launch_testing/launch_testing/proc_info_handler.py
@@ -15,7 +15,9 @@
 """
 A module providing process info capturing classes.
 
-PYTEST_DONT_REWRITE
+To prevent pytest from rewriting this module assertions, please PYTEST_DONT_REWRITE.
+See https://docs.pytest.org/en/latest/assert.html#disabling-assert-rewriting for
+further reference.
 """