DOC: update description of help function - gsl-shell.git - gsl-shell

index : gsl-shell.git
gsl-shell
summary refs log tree commit diff
diff options
context:
space:
mode:
authorFrancesco Abbate <francesco.bbt@gmail.com>2012年11月18日 23:18:53 +0100
committerFrancesco Abbate <francesco.bbt@gmail.com>2012年11月18日 23:18:53 +0100
commit0ed858b0f25f24bff81aac83e6f4f5205e68bb26 (patch)
tree1f3bf186287cc8ce336e400b8105f6c8afe43f44
parent4e2f51e7c405015e6d9a170dee54e5867ad52bd3 (diff)
downloadgsl-shell-0ed858b0f25f24bff81aac83e6f4f5205e68bb26.tar.gz
DOC: update description of help function
Diffstat
-rw-r--r--doc/user-manual/general.rst 4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/user-manual/general.rst b/doc/user-manual/general.rst
index 15f2dd94..f47ad71c 100644
--- a/doc/user-manual/general.rst
+++ b/doc/user-manual/general.rst
@@ -30,8 +30,8 @@ Overview
When this happens it does return a string corresponding to its actual type instead of "userdata" or "cdata".
For complex number and real or complex matrix it does return respectively "complex", "matrix" and "complex matrix".
-.. function:: help(f)
+.. function:: help(obj)
- Print some help, if available, about the function "f".
+ Print some help, if available, about the given object or function.
In the first line it will be shown how the function should be called.
If the function have some optional parameters these will be shown inside square brackets.
generated by cgit v1.2.3 (git 2.46.0) at 2025年10月06日 22:00:29 +0000

AltStyle によって変換されたページ (->オリジナル) /