From 39ee8b0580ee48c43801feaa0c9a5b454a3e0e19 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Wed, 8 Dec 2021 17:09:27 +0000 Subject: Store raw help string for commands Some tools, such as sphinx-click [1], may wish to access the full help string for a command including any text after the form feed character (which indicates truncation [2]). Make this possible by storing the help string without truncation and instead truncate when we use this string (i.e. truncate on load, not on store). [1] https://github.com/click-contrib/sphinx-click/issues/56 [2] https://click.palletsprojects.com/en/latest/documentation/#truncating-help-texts Signed-off-by: Stephen Finucane --- CHANGES.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'CHANGES.rst') diff --git a/CHANGES.rst b/CHANGES.rst index 35307d4..ebf14e6 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -33,6 +33,8 @@ Version 8.1.0 processed. :issue:`1985` - A flag option with ``required=True`` requires that the flag is passed instead of choosing the implicit default value. :issue:`1978` +- Store untruncated help string in ``Command.help``, and perform + truncation when formatting. :issue:`2149` Version 8.0.4 -- cgit v1.2.1