From a486cb8d36ba711d62b7e0a80d7e58c6540a4f5e Mon Sep 17 00:00:00 2001 From: Eric Mertens Date: Thu, 19 Sep 2024 15:41:52 -0700 Subject: [PATCH] update rpc docs --- cryptol-remote-api/docs/Cryptol.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/cryptol-remote-api/docs/Cryptol.rst b/cryptol-remote-api/docs/Cryptol.rst index 48956ee63..c7a3e0c51 100644 --- a/cryptol-remote-api/docs/Cryptol.rst +++ b/cryptol-remote-api/docs/Cryptol.rst @@ -677,6 +677,32 @@ Return fields +visible modules (command) +~~~~~~~~~~~~~~~~~~~~~~~~~ + +List the currently visible (i.e., in scope) module names. + +Parameter fields +++++++++++++++++ + +No parameters + + +Return fields ++++++++++++++ + + +``name`` + A human-readable representation of the name + + + +``documentation`` + An optional field containing documentation string for the name, if it is documented + + + + check type (command) ~~~~~~~~~~~~~~~~~~~~