Skip to content

Commit b1d3821

Browse files
committed
fix(changelog): mark get_smart_tag_range as deprecated
1 parent b429794 commit b1d3821

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

commitizen/changelog.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
from itertools import chain
3636
from typing import TYPE_CHECKING, Any
3737

38+
from deprecated import deprecated
3839
from jinja2 import (
3940
BaseLoader,
4041
ChoiceLoader,
@@ -285,7 +286,11 @@ def get_next_tag_name_after_version(tags: Iterable[GitTag], version: str) -> str
285286
raise NoCommitsFoundError(f"Could not find a valid revision range. {version=}")
286287

287288

288-
# TODO: unused, deprecate this?
289+
@deprecated(
290+
reason="This function is unused and will be removed in v5",
291+
version="5.0.0",
292+
category=DeprecationWarning,
293+
)
289294
def get_smart_tag_range(
290295
tags: Sequence[GitTag], newest: str, oldest: str | None = None
291296
) -> list[GitTag]:

0 commit comments

Comments
 (0)