From d873504bcd2f9b15b3f11dcc954bea6431cb5ff2 Mon Sep 17 00:00:00 2001 From: Jack Morrison Date: Wed, 10 Apr 2024 13:19:11 -0700 Subject: [PATCH] Docs: update Job.nodelist description --- reframe/core/schedulers/__init__.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/reframe/core/schedulers/__init__.py b/reframe/core/schedulers/__init__.py index 483c8aff44..0d3771d7b7 100644 --- a/reframe/core/schedulers/__init__.py +++ b/reframe/core/schedulers/__init__.py @@ -512,13 +512,16 @@ def state(self): def nodelist(self): '''The list of node names assigned to this job. + This attribute is supported by the ``local``, ``pbs``, ``slurm``, + ``squeue``, ``ssh``, and ``torque`` scheduler backends. + This attribute is :class:`None` if no nodes are assigned to the job yet. - This attribute is set reliably only for the ``slurm`` backend, i.e., - Slurm *with* accounting enabled. + The ``squeue`` scheduler backend, i.e., Slurm *without* accounting, might not set this attribute for jobs that finish very quickly. - For the ``local`` scheduler backend, this returns an one-element list + + For the ``local`` scheduler backend, this returns a one-element list containing the hostname of the current host. This attribute might be useful in a flexible regression test for @@ -526,8 +529,6 @@ def nodelist(self): For more information on flexible node allocation, see the :option:`--flex-alloc-nodes` command-line option. - This attribute is *not* supported by the ``pbs`` scheduler backend. - .. versionadded:: 2.17 :type: :class:`List[str]` or :class:`None`