Skip to content

message_template description inaccurate? #288

Closed
@bradym

Description

@bradym

Type

  • Content inaccurate
  • Content missing
  • Typo

URL

https://commitizen-tools.github.io/commitizen/customization/

Description

The description for message_template currently reads (emphasis mine):

The template for generating message from the given answers. message_template should either follow the string.Template or Jinja2 formatting specification, and all the variables in this template should be defined in name in questions. Note that Jinja2 is not installed by default. If not installed, commitizen will use string.Template formatting.

It seems the bold sentence is actually backwards as Jinja2 is installed by default as it is defined as a dependency.

I'm happy to submit a PR to fix, but wanted to confirm the issue first.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions