From f6f87fec95cfa2322f162395237933cf3960bfee Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Mon, 28 Nov 2022 15:37:20 +0100 Subject: [PATCH] ubuiltins: Document help. --- src/ubuiltins/__init__.py | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/src/ubuiltins/__init__.py b/src/ubuiltins/__init__.py index d940f74..ce1bd15 100644 --- a/src/ubuiltins/__init__.py +++ b/src/ubuiltins/__init__.py @@ -565,8 +565,16 @@ def help(object: Any) -> None: def help(*args) -> None: """ - Prints help for the ``object``. If no argument is given, prints general help. - If object is ``'modules'``, prints available modules. + help() + help(object) + + Get information about an object. + + If no arguments are given, this function prints instructions to operate the + REPL. If the argument is ``"modules"``, it prints the available modules. + + Arguments: + object: Object for which to print help information. """