From 7bc16d39b2c37e4fa7cb065449e8a86a67e2e1f0 Mon Sep 17 00:00:00 2001 From: "Jason C. Nucciarone" Date: Fri, 20 Sep 2024 13:32:28 -0400 Subject: [PATCH] docs: revise `slurmutils.editors` section Don't duplicate the header of each section but with only the configuration file name changed. Instead, just have one header at the beginning that states that the modules in this collection support editing the various configuration files that Slurm has. Signed-off-by: Jason C. Nucciarone --- README.md | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index c9fb81f..311f811 100644 --- a/README.md +++ b/README.md @@ -47,13 +47,12 @@ $ poetry install ### Usage -#### Editors +#### `slurmutils.editors` -##### `slurmconfig` +This module provides an API for editing files, and creating new files if they do not +exist. Here's some operations you can perform on files using the editors in this module: -This module provides an API for editing both _slurm.conf_ and _Include_ files, -and can create new configuration files if they do not exist. Here's some common Slurm -lifecycle management operators you can perform using this editor: +##### `slurmconfig` ###### Edit a pre-existing _slurm.conf_ configuration file @@ -86,10 +85,6 @@ with slurmconfig.edit("/etc/slurm/slurm.conf") as config: ##### `slurmdbdconfig` -This module provides an API for editing _slurmdbd.conf_ files, and can create new -_slurmdbd.conf_ files if they do not exist. Here's some operations you can perform -on the _slurmdbd.conf_ file using this editor: - ###### Edit a pre-existing _slurmdbd.conf_ configuration file ```python @@ -105,10 +100,6 @@ with slurmdbdconfig.edit("/etc/slurm/slurmdbd.conf") as config: ##### `cgroupconfig` -This module provides an API for editing _cgroup.conf_ files, and create new _cgroup.conf_ -files if they do not exist. Here's some operations you can perform on the _cgroup.conf_ -file using this editor: - ```python from slurmutils.editors import cgroupconfig