From e84c7202b62846d6ee2fcd4a877c284fffe0f6ca Mon Sep 17 00:00:00 2001 From: Kevin Deldycke Date: Fri, 6 Mar 2026 10:28:20 +0400 Subject: [PATCH] Mark `make_default_short_help` as private API Refs: https://github.com/pallets/click/issues/3189#issuecomment-3774030149 --- CHANGES.rst | 1 + src/click/utils.py | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 3521fe1b81..02603f323e 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -13,6 +13,7 @@ Unreleased ``semver.Version``. :issue:`3298` :pr:`3299` - Fix pager test pollution under parallel execution by using pytest's ``tmp_path`` fixture instead of a shared temporary file path. :pr:`3238` +- Mark ``make_default_short_help`` as private API. :issue:`3189` :pr:`3250` Version 8.3.2 ------------- diff --git a/src/click/utils.py b/src/click/utils.py index beae26f761..89cae3b99c 100644 --- a/src/click/utils.py +++ b/src/click/utils.py @@ -57,7 +57,10 @@ def make_str(value: t.Any) -> str: def make_default_short_help(help: str, max_length: int = 45) -> str: - """Returns a condensed version of help string.""" + """Returns a condensed version of help string. + + :meta private: + """ # Consider only the first paragraph. paragraph_end = help.find("\n\n")