Skip to content

Commit

Permalink
docs: include the default for entry_title_template
Browse files Browse the repository at this point in the history
Suggested by #98
  • Loading branch information
Ned Batchelder committed Oct 9, 2023
1 parent 4fb7f9c commit 5ecd5be
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
7 changes: 4 additions & 3 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ file.
if isinstance(default, list):
default = ", ".join(default)
default = f"``{default}``"
print(f"Default: {default}")
print("\n".join(textwrap.wrap(f"Default: {default}")))
print()
.. ]]]
Expand Down Expand Up @@ -235,7 +235,8 @@ entry_title_template
The `Jinja`_ template to use for the entry heading text for
changelog entries created by ":ref:`cmd_collect`".

Default: A combination of version (if specified) and date.
Default: ``{% if version %}{{ version }} — {% endif %}{{
date.strftime('%Y-%m-%d') }}``


.. _config_format:
Expand Down Expand Up @@ -370,7 +371,7 @@ source file.

Default: (empty)

.. [[[end]]] (checksum: b0f7694ada9dcecd8e7e14387ee7cd88)
.. [[[end]]] (checksum: 675df32fb207262bd0c69a94a99c2fb7)
.. _git_settings:
Expand Down
1 change: 0 additions & 1 deletion src/scriv/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,6 @@ class _Options:
The `Jinja`_ template to use for the entry heading text for
changelog entries created by ":ref:`cmd_collect`".
""",
"doc_default": "A combination of version (if specified) and date.",
},
)

Expand Down

0 comments on commit 5ecd5be

Please sign in to comment.