Update docstrings.

Author: domdfcoding

consolekit/commands.py

@@ -336,7 +336,11 @@ class ContextInheritingGroup(click.Group):
 	.. autosummary-widths:: 5/16
 	"""
 
-	def command(self, *args, **kwargs) -> Callable[[Callable[..., Any]], click.Command]:  # type: ignore[override]
+	def command(  # type: ignore[override]  # noqa: PRM002
+			self,
+			*args,
+			**kwargs,
+			) -> Callable[[Callable[..., Any]], click.Command]:
 		"""
 		A shortcut decorator for declaring and attaching a command to the group.
 
@@ -348,7 +352,11 @@ def command(self, *args, **kwargs) -> Callable[[Callable[..., Any]], click.Comma
 		kwargs.setdefault("context_settings", self.context_settings)
 		return super().command(*args, **kwargs)
 
-	def group(self, *args, **kwargs) -> Callable[[Callable[..., Any]], click.Group]:  # type: ignore[override]
+	def group(  # type: ignore[override]  # noqa: PRM002
+			self,
+			*args,
+			**kwargs,
+			) -> Callable[[Callable[..., Any]], click.Group]:
 		"""
 		A shortcut decorator for declaring and attaching a group to the group.
 

consolekit/input.py

@@ -233,7 +233,8 @@ def stderr_input(prompt: str = '', file: IO = sys.stdout) -> str:  # pragma: no
 
 	On Unix, GNU readline is used if enabled.
 
-	The ``prompt`` string, if given, is printed to stderr without a trailing newline before reading.
+	:param prompt: If given, is printed to stderr without a trailing newline before reading.
+	:param file:
 	"""
 
 	if file is sys.stdout:

consolekit/options.py

@@ -231,7 +231,7 @@ def flag_option(*args, default: Optional[bool] = False, **kwargs) -> Callable[[_
 			)
 
 
-def auto_default_option(*param_decls, **attrs) -> Callable[[_C], _C]:
+def auto_default_option(*param_decls, **attrs) -> Callable[[_C], _C]:  # noqa: PRM002
 	"""
 	Attaches an option to the command, with a default value determined from the decorated function's signature.
 
@@ -279,7 +279,7 @@ def _get_default_from_callback_and_set(command: click.Command, param: click.Para
 			param.required = False
 
 
-def auto_default_argument(*param_decls, **attrs) -> Callable[[_C], _C]:
+def auto_default_argument(*param_decls, **attrs) -> Callable[[_C], _C]:  # noqa: PRM002
 	"""
 	Attaches an argument to the command, with a default value determined from the decorated function's signature.
 
@@ -459,7 +459,7 @@ def get_default(self, ctx):  # noqa: MAN001,MAN002,D102
 
 class _Option(click.Option):
 
-	def prompt_for_value(self, ctx: click.Context):  # noqa: MAN002
+	def prompt_for_value(self, ctx: click.Context):  # noqa: MAN002,PRM002
 		"""
 		This is an alternative flow that can be activated in the full value processing if a value does not exist.
 
@@ -489,7 +489,7 @@ def prompt_for_value(self, ctx: click.Context):  # noqa: MAN002
 				)
 
 
-class DescribedArgument(click.Argument):
+class DescribedArgument(click.Argument):  # noqa: PRM002
 	r"""
 	:class:`click.Argument` with an additional keyword argument and attribute giving a short description.
 

consolekit/terminal_colours.py

@@ -243,6 +243,8 @@ def __exit__(self, exc_type, exc_val, exc_tb) -> None:
 	def __call__(self, text) -> str:  # noqa: MAN001
 		"""
 		Returns the given text in this colour.
+
+		:param text: Any object that can be converted to string (but typically a :class:`str` or perhaps :class:`int` or :class:`float`).
 		"""
 
 		return f"{self}{text}{self.reset}"
@@ -447,7 +449,7 @@ class AnsiCodes(ABC):
 	_stack: Union[Deque[str], List[str]]
 	_reset: str
 
-	def __init_subclass__(cls, **kwargs) -> None:
+	def __init_subclass__(cls, **kwargs) -> None:  # noqa: PRM002
 		"""
 		The subclasses declare class attributes which are numbers.
 

consolekit/testing.py

@@ -99,6 +99,7 @@ class Result(click.testing.Result):
 	:param exit_code: The command's exit code.
 	:param exception: The exception that occurred, if any.
 	:param exc_info: The traceback, if an exception occurred.
+	:param output_bytes:
 	"""
 
 	runner: click.testing.CliRunner

consolekit/utils.py

@@ -164,7 +164,7 @@ def overtype(
 
 	.. TODO:: This does not currently work in the PyCharm console, at least on Windows
 
-	:param objects: A list of strings or string-like objects to write to the terminal.
+	:param \*objects: A list of strings or string-like objects to write to the terminal.
 	:param sep: String to separate the objects with.
 	:param end: String to end with.
 	:param file: An object with a ``write(string)`` method.

consolekit/versions.py

@@ -87,14 +87,13 @@ def get_version_callback(
 	With each ``--version`` argument the callback displays the package version,
 	then adds the python version, and finally adds dependency versions.
 
-
 	:param tool_version: The version of the tool to show the version of.
 	:param tool_name: The name of the tool to show the version of.
 	:param dependencies: Either a list of dependency names,
 	    or a mapping of dependency name to a more human-readable form.
 	"""
 
-	def version_callback(ctx: click.Context, param: click.Option, value: int) -> None:
+	def version_callback(ctx: click.Context, param: click.Option, value: int) -> None:  # noqa: PRM002
 		"""
 		Callback for displaying the package version (and optionally the Python runtime).
 		"""