Skip to content
This repository was archived by the owner on Sep 3, 2024. It is now read-only.

Commit 0965ecf

Browse files
author
William McLendon
committed
DOC: Cleaning up README.md
1 parent aeceec4 commit 0965ecf

File tree

2 files changed

+18
-12
lines changed

2 files changed

+18
-12
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ The `SetProgramOptions` package extends [`ConfigParserEnhanced`][5] to enable th
99
processing of **.ini** files that specify **command line program options**.
1010

1111
As a subclass of ConfigParserEnhanced, SetProgramOptions supports all
12-
the _operations_ that [`ConfigParserEnhanced`][2] supports and adds some of its
12+
the _operations_ that [`ConfigParserEnhanced`][5] supports and adds some of its
1313
own. The following table notes the new **operations** that SetProgramOptions adds:
1414

1515
| Operation | Format | Defined By |
1616
| ------------ | --------------------------------------------- | --------------------------- |
17-
| `use` | `use <section>` | [`ConfigParserEnhanced`][2] |
17+
| `use` | `use <section>` | [`ConfigParserEnhanced`][5] |
1818
| `opt-set` | `opt-set Param1 [Param2..ParamN] [: <VALUE>]` | `SetProgramOptions` |
1919
| `opt-remove` | `opt-remove Param [SUBSTR]` | `SetProgramOptions` |
2020

@@ -36,27 +36,32 @@ Supported Operations
3636
--------------------
3737

3838
### `use`
39-
The `use` operation is inherited from [`ConfigParserEnhanced`][2]. Please see its documentation on this command and its use.
39+
The `use` operation is inherited from [`ConfigParserEnhanced`][5]. Please see its documentation
40+
on this command and its use.
4041

4142
### `opt-set`
4243
Sets a generic _command line_ style option.
4344

4445
The format of this is `opt-set Param1 [Param2] [Param3] ... [ParamN] : [VALUE]`
4546

46-
In a _bash_ context, this operation attempts to generate an option for some command that will be executed.
47-
`SetProgramOptions` will concactenate the _Params_ together and then append `=VALUE` if a VALUE field is present.
47+
In a _bash_ context, this operation attempts to generate an option for some command
48+
that will be executed.
49+
`SetProgramOptions` will concactenate the _Params_ together and then append `=VALUE`
50+
if a VALUE field is present.
4851
For example, `opt-set Foo Bar : Baz` will become `FooBar=Baz`.
4952

5053

5154
### `opt-remove`
52-
_Removes_ existing entries that have been processed up to the point the `opt-remove` is encountered that match a pattern.
55+
_Removes_ existing entries that have been processed up to the point the `opt-remove` is
56+
encountered that match a pattern.
5357

5458
The format of this is `opt-remove Param [SUBSTR]`
5559

56-
When a _remove_ is encountered, `SetProgramOptions` will search through all processed options and will delete any
57-
that contain any _Param-i_ that matches `Param`. By default the parameters much be an _exact match_ of `Param`, but
58-
if the optional `SUBSTR` parameter is provided then `SetProgramOptions` will treat `Param` as a substring and will
59-
remove all existing options if _any parameter contains Param_.
60+
When a _remove_ is encountered, `SetProgramOptions` will search through all processed
61+
options and will delete any that contain any _Param-i_ that matches `Param`.
62+
By default the parameters much be an _exact match_ of `Param`, but if the optional
63+
`SUBSTR` parameter is provided then `SetProgramOptions` will treat `Param` as a
64+
substring and will remove all existing options if _any parameter contains Param_.
6065

6166

6267
SetProgramOptions Config Files
@@ -447,6 +452,7 @@ Done
447452
[1]: https://cmake.org/cmake/help/latest/command/set.html
448453
[2]: https://github.com/sandialabs/ConfigParserEnhanced
449454
[3]: https://github.com/sandialabs/SetProgramOptions/blob/master/CHANGELOG.md
450-
[4]: https://setprogramoptions.readthedocs.io/en/latest
455+
[4]: https://setprogramoptions.readthedocs.io/
451456
[5]: https://pypi.org/project/configparserenhanced/
452457
[6]: https://www.cmake.org/
458+
[7]: https://configparserenhanced.readthedocs.io/

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[tool.poetry]
22
name = "setprogramoptions"
33
description = "Program options configuration file reader using ConfigParserEnhanced."
4-
version = "0.5.0a0"
4+
version = "0.5.0a2"
55
license = "LICENSE"
66
readme = "README.md"
77
keywords = [

0 commit comments

Comments
 (0)