Skip to content

Commit e84c720

Browse files
committed
Mark make_default_short_help as private API
Refs: #3189 (comment)
1 parent 1339fd3 commit e84c720

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

CHANGES.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Unreleased
1313
``semver.Version``. :issue:`3298` :pr:`3299`
1414
- Fix pager test pollution under parallel execution by using pytest's
1515
``tmp_path`` fixture instead of a shared temporary file path. :pr:`3238`
16+
- Mark ``make_default_short_help`` as private API. :issue:`3189` :pr:`3250`
1617

1718
Version 8.3.2
1819
-------------

src/click/utils.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,10 @@ def make_str(value: t.Any) -> str:
5757

5858

5959
def make_default_short_help(help: str, max_length: int = 45) -> str:
60-
"""Returns a condensed version of help string."""
60+
"""Returns a condensed version of help string.
61+
62+
:meta private:
63+
"""
6164
# Consider only the first paragraph.
6265
paragraph_end = help.find("\n\n")
6366

0 commit comments

Comments
 (0)