Skip to content

Commit

Permalink
docs: revise slurmutils.editors section
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
NucciTheBoss committed Sep 20, 2024
1 parent 10b30be commit 7bc16d3
Showing 1 changed file with 4 additions and 13 deletions.
17 changes: 4 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand All @@ -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

Expand Down

0 comments on commit 7bc16d3

Please sign in to comment.