Skip to content

Commit

Permalink
Fix option name.
Browse files Browse the repository at this point in the history
  • Loading branch information
felixfontein committed Feb 11, 2024
1 parent 50914fd commit 40341ed
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/changelog-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ parts of the version of the release.

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

### `output_format` (list of strings)
### `output_formats` (list of strings)

The default is `["rst"]`.

Expand Down
2 changes: 1 addition & 1 deletion docs/changelogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ file to your needs. The settings of highest interest are:

1. `title`: This is by default the titlecase of your collection's
namespace and name. Feel free to insert a nicer name here.
2. `output_format`: This is by default `[rst]`. Change this to `[rst, md]`
2. `output_formats`: This is by default `[rst]`. Change this to `[rst, md]`
to output both a RST and MarkDown version of the changelog, or to `[md]`
to only output a MarkDown version.
3. `keep_fragments`: The default value `false` removes the fragment
Expand Down
2 changes: 1 addition & 1 deletion docs/other-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ configuration file to your needs. The settings of highest interest are:

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

0 comments on commit 40341ed

Please sign in to comment.