From c335bf5dc57250d8a9c4069c4e4d4afb7fcc7852 Mon Sep 17 00:00:00 2001 From: Calvin Rose Date: Thu, 23 Apr 2020 12:15:12 -0500 Subject: [PATCH] Update doc doc. --- src/boot/boot.janet | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/boot/boot.janet b/src/boot/boot.janet index fcaa26a8..47f35ca2 100644 --- a/src/boot/boot.janet +++ b/src/boot/boot.janet @@ -1557,7 +1557,7 @@ (print)) (defn doc* - "Get the documentation for a symbol in a given environment." + "Get the documentation for a symbol in a given environment. Function form of doc." [&opt sym] (cond @@ -1591,7 +1591,10 @@ (print-index identity))) (defmacro doc - "Shows documentation for the given symbol." + "Shows documentation for the given symbol, or can show a list of available bindings. + If sym is a symbol, will look for documentation for that symbol. If sym is a string + or is not provided, will show all lexical and dynamic bindings in the current environment with + that prefix (all bindings will be shown if no prefix is given)." [&opt sym] ~(,doc* ',sym))