Added Choice members documentation, versionadded, and slightly change…

…d docstring.
pallets · Nov 3, 2024 · f500a8e · f500a8e
1 parent 723b0c4
commit f500a8e
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -54,8 +54,8 @@ Unreleased
 -   When using ``Option.envvar`` with ``Option.flag_value``, the ``flag_value``
     will always be used instead of the value of the environment variable.
     :issue:`2746` :pr:`2788`
--   Add new method to ``Choice`` for getting a fail message and refactor
-    the convert method to use it.
+-   Add ``Choice.get_invalid_choice_message`` method for customizing the
+    invalid choice message.
 
 
 Version 8.1.8

diff --git a/docs/api.rst b/docs/api.rst
@@ -134,6 +134,7 @@ Types
 .. autoclass:: Path
 
 .. autoclass:: Choice
+   :members:
 
 .. autoclass:: IntRange
 

diff --git a/src/click/types.py b/src/click/types.py
@@ -311,7 +311,7 @@ def get_invalid_choice_message(self, value: t.Any) -> str:
 
         :param value: The invalid value.
 
-        :return: Error message for the invalid choice.
+        .. versionadded:: 8.2
         """
         choices_str = ", ".join(map(repr, self.choices))
         return ngettext(