Skip to content

Commit 96b98f8

Browse files
committed
Add on description of Changelogs arguments
1 parent c339a5f commit 96b98f8

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

exasol/toolbox/util/release/changelog.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@
1717

1818
class Changelogs:
1919
def __init__(self, changes_path: Path, root_path: Path, version: Version) -> None:
20+
"""
21+
Args:
22+
changes_path: directory containing the changelog, e.g. `doc/changes/`
23+
root_path: root directory of the current project, containing file
24+
`pyproject.toml`
25+
version: the version to be used in the `changes_{version}.md` and listed in the `changelog.md`.
26+
"""
27+
2028
self.version = version
2129
self.unreleased_md: Path = changes_path / "unreleased.md"
2230
self.versioned_changelog_md: Path = changes_path / f"changes_{version}.md"

0 commit comments

Comments
 (0)