Skip to content

Commit c55ea42

Browse files
authored
Merge pull request #6778 from oliver-sanders/psutil-docs++
psutil: document kwarg limitation
2 parents 554f41d + 0557866 commit c55ea42

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

cylc/flow/cfgspec/globalcfg.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -893,7 +893,10 @@ def default_for(
893893
894894
This should be a multiline string containing Python expressions
895895
to rank and/or filter hosts. All `psutil`_ attributes are
896-
available for use in these expressions.
896+
available for use in these expressions, e.g, ``cpu_percent``.
897+
You can supply these with positional arguments e.g,
898+
``cpu_percent(1)``, however, keyword arguments will not work
899+
e.g, ``cpu_percent(interval=1)``.
897900
898901
.. rubric:: Ranking
899902

0 commit comments

Comments
 (0)