Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Unreleased
``pytest-xdist`` to detect test pollution and race conditions. :pr:`3151`
- Add contributor documentation for running stress tests, randomized
parallel tests, and Flask smoke tests. :pr:`3151` :pr:`3177`
- Mark ``make_default_short_help`` as private API. :issue:`3189` :pr:`3250`
- ``CliRunner``'s redirected streams now expose the original file descriptor
via ``fileno()``, so that ``faulthandler``, ``subprocess``, and other
C-level consumers no longer crash with ``io.UnsupportedOperation``.
Expand Down
5 changes: 4 additions & 1 deletion src/click/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -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")

Expand Down