Skip to content

Commit 40341ed

Browse files
committed
Fix option name.
1 parent 50914fd commit 40341ed

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

docs/changelog-configuration.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ parts of the version of the release.
4646

4747
> [!NOTE]
4848
> The file extension (default `.rst`) will always be replaced by the
49-
> extension matching the output format (see [`output_format`](#output_format-list-of-strings)).
49+
> extension matching the output format (see [`output_formats`](#output_formats-list-of-strings)).
5050
> Therefore the extension provided here will always be ignored.
5151
5252
### `changelog_filename_version_depth` (integer)
@@ -240,7 +240,7 @@ When set to `true`, uses FQCN (Fully Qualified Collection Names) when
240240
mentioning new plugins and modules. This means that `namespace.name.`
241241
is prepended to the plugin respectively module names.
242242

243-
### `output_format` (list of strings)
243+
### `output_formats` (list of strings)
244244

245245
The default is `["rst"]`.
246246

docs/changelogs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ file to your needs. The settings of highest interest are:
3737

3838
1. `title`: This is by default the titlecase of your collection's
3939
namespace and name. Feel free to insert a nicer name here.
40-
2. `output_format`: This is by default `[rst]`. Change this to `[rst, md]`
40+
2. `output_formats`: This is by default `[rst]`. Change this to `[rst, md]`
4141
to output both a RST and MarkDown version of the changelog, or to `[md]`
4242
to only output a MarkDown version.
4343
3. `keep_fragments`: The default value `false` removes the fragment

docs/other-projects.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ configuration file to your needs. The settings of highest interest are:
3636

3737
1. `title`: This is by default `Project`. Please replace this with the
3838
name of your project.
39-
2. `output_format`: This is by default `[rst]`. Change this to `[rst, md]`
39+
2. `output_formats`: This is by default `[rst]`. Change this to `[rst, md]`
4040
to output both a RST and MarkDown version of the changelog, or to `[md]`
4141
to only output a MarkDown version.
4242
3. `use_semantic_versioning`: The default value `true` assumes that

0 commit comments

Comments
 (0)