Skip to content

Commit 05f3a55

Browse files
committed
add better marker description.
1 parent b8e66ea commit 05f3a55

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

docs/reference_guides/marks.rst

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,35 @@ pytask.mark.try_first
3232
.. function:: try_first
3333
:noindex:
3434

35-
This
35+
Indicate that the task should be executed as soon as possible.
36+
37+
This indicator is a soft measure to influence the execution order of pytask.
38+
39+
.. important::
40+
41+
This indicator is not intended for general use to influence the build order and
42+
to overcome misspecification of task dependencies and products.
43+
44+
It should only be applied to situations where it is hard to define all
45+
dependencies and products and automatic inference may be incomplete like with
46+
pytask-latex and latex-dependency-scanner.
47+
48+
49+
pytask.mark.try_last
50+
---------------------
51+
52+
.. function:: try_last
53+
:noindex:
54+
55+
Indicate that the task should be executed as late as possible.
56+
57+
This indicator is a soft measure to influence the execution order of pytask.
58+
59+
.. important::
60+
61+
This indicator is not intended for general use to influence the build order and
62+
to overcome misspecification of task dependencies and products.
63+
64+
It should only be applied to situations where it is hard to define all
65+
dependencies and products and automatic inference may be incomplete like with
66+
pytask-latex and latex-dependency-scanner.

0 commit comments

Comments
 (0)