diff --git a/nixos/doc/manual/development/writing-nixos-tests.section.md b/nixos/doc/manual/development/writing-nixos-tests.section.md index da965ce09e36..6934bb0face7 100644 --- a/nixos/doc/manual/development/writing-nixos-tests.section.md +++ b/nixos/doc/manual/development/writing-nixos-tests.section.md @@ -347,7 +347,7 @@ import ./make-test-python.nix { ## Failing tests early {#ssec-failing-tests-early} -To fail tests early when certain invariables are no longer met (instead of waiting for the build to time out), the decorator `polling_condition` is provided. For example, if we are testing a program `foo` that should not quit after being started, we might write the following: +To fail tests early when certain invariants are no longer met (instead of waiting for the build to time out), the decorator `polling_condition` is provided. For example, if we are testing a program `foo` that should not quit after being started, we might write the following: ```py @polling_condition @@ -369,29 +369,29 @@ with foo_running: : specifies how often the condition should be polled: - ```py - @polling_condition(seconds_interval=10) - def foo_running(): - machine.succeed("pgrep -x foo") - ``` +```py +@polling_condition(seconds_interval=10) +def foo_running(): + machine.succeed("pgrep -x foo") +``` `description` : is used in the log when the condition is checked. If this is not provided, the description is pulled from the docstring of the function. These two are therefore equivalent: - ```py - @polling_condition - def foo_running(): - "check that foo is running" - machine.succeed("pgrep -x foo") - ``` +```py +@polling_condition +def foo_running(): + "check that foo is running" + machine.succeed("pgrep -x foo") +``` - ```py - @polling_condition(description="check that foo is running") - def foo_running(): - machine.succeed("pgrep -x foo") - ``` +```py +@polling_condition(description="check that foo is running") +def foo_running(): + machine.succeed("pgrep -x foo") +``` ## Adding Python packages to the test script {#ssec-python-packages-in-test-script} diff --git a/nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml b/nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml index 7e4af0382906..d6f4f61c0645 100644 --- a/nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml +++ b/nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml @@ -607,7 +607,7 @@ import ./make-test-python.nix {
Failing tests early - To fail tests early when certain invariables are no longer met + To fail tests early when certain invariants are no longer met (instead of waiting for the build to time out), the decorator polling_condition is provided. For example, if we are testing a program foo that should not @@ -635,12 +635,10 @@ with foo_running: : specifies how often the condition should be polled: - -```py + @polling_condition(seconds_interval=10) def foo_running(): machine.succeed("pgrep -x foo") -``` description @@ -650,19 +648,16 @@ def foo_running(): provided, the description is pulled from the docstring of the function. These two are therefore equivalent: - -```py + @polling_condition def foo_running(): "check that foo is running" machine.succeed("pgrep -x foo") -``` - -```py + + @polling_condition(description="check that foo is running") def foo_running(): machine.succeed("pgrep -x foo") -```