From 40341ed624234a90448aef457a27b3d918bf1f78 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Sun, 11 Feb 2024 10:52:06 +0100 Subject: [PATCH] Fix option name. --- docs/changelog-configuration.md | 4 ++-- docs/changelogs.md | 2 +- docs/other-projects.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/changelog-configuration.md b/docs/changelog-configuration.md index 2b7cad1..ab4cb39 100644 --- a/docs/changelog-configuration.md +++ b/docs/changelog-configuration.md @@ -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) @@ -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"]`. diff --git a/docs/changelogs.md b/docs/changelogs.md index 976d4d3..5cea391 100644 --- a/docs/changelogs.md +++ b/docs/changelogs.md @@ -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 diff --git a/docs/other-projects.md b/docs/other-projects.md index f4fef35..a463824 100644 --- a/docs/other-projects.md +++ b/docs/other-projects.md @@ -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