Skip to content

Commit

Permalink
refresh api docs .md
Browse files Browse the repository at this point in the history
  • Loading branch information
glguy committed Jan 31, 2025
1 parent b988d33 commit aa39988
Showing 1 changed file with 99 additions and 0 deletions.
99 changes: 99 additions & 0 deletions cryptol-remote-api/docs/Cryptol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,50 @@ The result of executing a single REPL command.



.. _ScanStatus:
ScanStatus
~~~~~~~~~~

List of module names and status of each.


``scanned``
This file was successfully parsed and contains a change status.



``invalid_module``
This file could not be parsed an analyzed due to syntax issues.



``invalid_dep``
This file depends on a module that was not able to be loaded.



.. _LoadProjectMode:
LoadProjectMode
~~~~~~~~~~~~~~~




``modified``
Load modified files and files that depend on modified files



``untested``
Load files that do not have a current test result



``refresh``
Reload all files in the project discarding the cache results




Methods
-------
Expand Down Expand Up @@ -548,6 +592,27 @@ Return fields



focus module (command)
~~~~~~~~~~~~~~~~~~~~~~

Focus the specified module (by name).

Parameter fields
++++++++++++++++


``module name``
Name of module to focus.



Return fields
+++++++++++++

No return fields



evaluate expression (command)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -817,6 +882,40 @@ Return fields



load project (command)
~~~~~~~~~~~~~~~~~~~~~~

Load project returning a list of all the modules and whether they have changed since the last load

Parameter fields
++++++++++++++++


``path``
Path to directory containing the project



``mode``
One of the modes described at :ref:`LoadProjectMode <LoadProjectMode>`.



Return fields
+++++++++++++


``scan_status``
List of module name and :ref:` scan status <ScanStatus>`.



``test_results``
List of module name and cached test result.




interrupt (notification)
~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit aa39988

Please sign in to comment.