more doc stuff

Author: tazend

pyslurm/core/slurmctld/base.pyx

@@ -197,7 +197,7 @@ def takeover(index = 1):
 
 
 def add_debug_flags(flags):
-    """Add DebugFlags to slurmctld
+    """Add DebugFlags to `slurmctld`
 
     Args:
         flags (list[str]):
@@ -222,7 +222,7 @@ def add_debug_flags(flags):
 
 
 def remove_debug_flags(flags):
-    """Remove DebugFlags from slurmctld.
+    """Remove DebugFlags from `slurmctld`.
 
     Args:
         flags (list[str]):
@@ -247,7 +247,7 @@ def remove_debug_flags(flags):
 
 
 def clear_debug_flags():
-    """Remove all currently set debug flags from slurmctld.
+    """Remove all currently set debug flags from `slurmctld`.
 
     Raises:
         (pyslurm.RPCError): When removing the debug flags was not successful.
@@ -267,7 +267,7 @@ def clear_debug_flags():
 
 
 def get_debug_flags():
-    """Get the current list of debug flags for the slurmctld.
+    """Get the current list of debug flags for the `slurmctld`.
 
     Raises:
         (pyslurm.RPCError): When getting the debug flags was not successful.
@@ -282,7 +282,7 @@ def get_debug_flags():
 
 
 def set_log_level(level):
-    """Set the logging level for slurmctld.
+    """Set the logging level for `slurmctld`.
 
     Args:
         level (str):
@@ -304,7 +304,7 @@ def set_log_level(level):
 
 
 def get_log_level():
-    """Get the current log level for the slurmctld.
+    """Get the current log level for the `slurmctld`.
 
     Raises:
         (pyslurm.RPCError): When getting the log level was not successful.
@@ -319,7 +319,7 @@ def get_log_level():
 
 
 def enable_scheduler_logging():
-    """Enable scheduler logging for slurmctld.
+    """Enable scheduler logging for `slurmctld`.
 
     Raises:
         (pyslurm.RPCError): When enabling scheduler logging was not successful.
@@ -334,7 +334,7 @@ def enable_scheduler_logging():
 
 
 def is_scheduler_logging_enabled():
-    """Check whether scheduler logging is enabled for slurmctld.
+    """Check whether scheduler logging is enabled for `slurmctld`.
 
     Returns:
        (bool): Whether scheduler logging is enabled or not.

pyslurm/core/slurmctld/config.pxd

@@ -441,7 +441,7 @@ cdef class Config:
             `SIGTERM` and `SIGKILL` signals upon reaching its time limit.
 
             {slurm.conf#OPT_KillWait}
-        launch_parameters (list[str])
+        launch_parameters (list[str]):
             Options for the job launch plugin.
 
             {slurm.conf#OPT_LaunchParameters}
@@ -606,8 +606,8 @@ cdef class Config:
 
             {slurm.conf#OPT_PriorityFlags}
         priority_max_age (int):
-            Job age that is needed before receiving the maximum age factor in
-            computing priority.
+            Job age (in seconds) that is needed before receiving the maximum
+            age factor in computing priority.
 
             {slurm.conf#OPT_PriorityMaxAge}
         priority_parameters (str):
@@ -1048,7 +1048,7 @@ cdef class Config:
             percentage of its real memory limit.
 
             {slurm.conf#OPT_VSizeFactor}
-        default_job_wait_time (int):
+        wait_time (int):
             Specifies how many seconds the srun command should by default wait
             after the first task terminates before terminating all remaining
             tasks.
@@ -1077,7 +1077,7 @@ cdef class Config:
 #
 # Copyright (C) 2022 SchedMD LLC.
 cdef class MPIConfig:
-    """Slurm MPI Config (mpi.conf)
+    """Slurm MPI Config (`mpi.conf`)
 
     Attributes:
         pmix_cli_tmp_dir_base (str):
@@ -1164,7 +1164,7 @@ cdef class MPIConfig:
 # pyslurm/slurm/SLURM_DISCLAIMER).
 # Copyright (C) 2010-2022 SchedMD LLC.
 cdef class CgroupConfig:
-    """Slurm Cgroup Config (cgroup.conf)
+    """Slurm Cgroup Config (`cgroup.conf`)
 
     Attributes:
         mountpoint (str):
@@ -1292,7 +1292,7 @@ cdef class CgroupConfig:
 # Copyright (C) 2012-2013 Bull.
 # Copyright (C) 2012-2022 SchedMD LLC.
 cdef class AccountingGatherConfig:
-    """Slurm Accounting Gather Config (acct_gather.conf)
+    """Slurm Accounting Gather Config (`acct_gather.conf`)
 
     Attributes:
         energy_ipmi_frequency (int):

pyslurm/core/slurmctld/config.pyx

@@ -752,8 +752,7 @@ cdef class Config:
         return cstr.to_list_free(&data)
 
     @property
-    def priortiy_max_age(self):
-        # TODO: seconds or minutes?
+    def priority_max_age(self):
         return u32_parse(self.ptr.priority_max_age)
 
     @property
@@ -912,7 +911,6 @@ cdef class Config:
 
     @property
     def scheduler_logging_enabled(self):
-        # TODO: check again
         return u16_parse_bool(self.ptr.sched_log_level)
 
     @property
@@ -1184,8 +1182,7 @@ cdef class Config:
         return u16_parse(self.ptr.vsize_factor)
 
     @property
-    def default_job_wait_time(self):
-        # TODO: reconsider name
+    def wait_time(self):
         return u16_parse(self.ptr.wait_time)
 
     @property

pyslurm/core/slurmctld/enums.pyx

@@ -33,6 +33,6 @@ class ShutdownMode(IntEnum):
 
 # A bit hacky, but it works for now. Putting the docstring under the enum value
 # does not work unfortunately.
-ShutdownMode.ALL.__doc__ = "Shutdown all daemons (slurmctld and slurmd)"
-ShutdownMode.CORE_FILE.__doc__ = "Shutdown only slurmctld, and create a coredump"
-ShutdownMode.CONTROLLER_ONLY.__doc__ = "Shutdown only slurmctld, without a coredump"
+ShutdownMode.ALL.__doc__ = "Shutdown all daemons (`slurmctld` and `slurmd`)"
+ShutdownMode.CORE_FILE.__doc__ = "Shutdown only `slurmctld`, and create a coredump"
+ShutdownMode.CONTROLLER_ONLY.__doc__ = "Shutdown only `slurmctld`, without a coredump"