Skip to content

Commit 2224808

Browse files
committed
Update documentation for clarification
The changes made update the wording in the documentation to clarify the roles of `include_bumps` and `exclude_bumps` in the bump-my-version configuration. Additionally, unnecessary repetition was removed and overlapping examples were also corrected.
1 parent 2df57cc commit 2224808

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/reference/configuration.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -736,9 +736,9 @@ if `True`, don't fail if the configured file is missing.
736736
type
737737
: list of strings
738738

739-
The `include_bumps` file configuration allows you to control when this file is changed by inclusion. Its alternative is the `exclude_bumps` configuration. When a `bump <version component>` command is issued, this file is changed only if the version component is in this list and not in [`exclude_bumps`](#exclude_bumps). The [parse](#parse) configuration defines version components.
739+
The `include_bumps` file configuration allows you to control when bump-my-version includes this file for changes. Its alternative is the `exclude_bumps` configuration. When a `bump <version component>` command is issued, this file is changed only if the version component is in this list and not in [`exclude_bumps`](#exclude_bumps). The [parse](#parse) configuration defines version components.
740740

741-
The default value, or an empty list, includes all version components.
741+
The default value, or an empty list, includes all version components.
742742

743743
### exclude_bumps
744744

@@ -753,17 +753,17 @@ The default value, or an empty list, includes all version components.
753753
type
754754
: list of strings
755755

756-
The `exclude_bumps` file configuration allows you to control when this file is changed by exclusion. Its alternative is the `include_bumps` configuration.When a `bump <version component>` command is issued, this file is only changed if the version component is *not in this list.* The [parse](#parse) configuration defines version components.
756+
The `exclude_bumps` file configuration allows you to control when bump-my-version excludes this file for changes. Its alternative is the `include_bumps` configuration. When a `bump <version component>` command is issued, this file is only changed if the version component is *not in this list.* The [parse](#parse) configuration defines version components.
757757

758758
The default value does not exclude anything.
759759

760760
### Examples
761761

762762
=== "TOML"
763763

764-
TOML allows us to specify the files using an [array of tables.](https://toml.io/en/v1.0.0#array-of-tables) TOML configuration files add two configuration fields to each file configuration: `filename` and `glob`. These fields are mutually exclusive: if you specify a value for both, only the `glob` value is used.
764+
TOML allows us to specify the files using an [array of tables.](https://toml.io/en/v1.0.0#array-of-tables) TOML configuration adds two fields to each file configuration: `filename` and `glob`. These fields are mutually exclusive: if you specify a value for both, only the `glob` value is used.
765765

766-
For example, to change `coolapp/__init__.py` with the defaults, and alter `CHANGELOG.md` in twice:
766+
For example, to change `coolapp/__init__.py` with the defaults and alter `CHANGELOG.md` twice:
767767

768768
```toml
769769
[[tool.bumpversion.files]]
@@ -790,9 +790,9 @@ The default value does not exclude anything.
790790
The configuration file format requires each section header to be unique. If you want to process a certain file multiple times, you may append a description between parens to the `file` keyword: `[bumpversion:file (special one):…]`.
791791

792792

793-
794-
For example, to change `coolapp/__init__.py` with the defaults, and alter `CHANGELOG.md` in twice:
795-
793+
794+
For example, to change `coolapp/__init__.py` with the defaults and alter `CHANGELOG.md` twice:
795+
796796
```ini
797797
[bumpversion:file:coolapp/__init__.py]
798798

0 commit comments

Comments
 (0)