diff --git a/README.rst b/README.rst index d121713be..f451ad835 100644 --- a/README.rst +++ b/README.rst @@ -77,11 +77,13 @@ in the library sources. The libraries are in repository ``cadet-frontend``, whic is assumed to be located in ``../cadet-frontend``, from the root of this repo. The command ``yarn jsdoc`` -makes the documentation available in folder +makes the documentation available in folder and updates the jsons for documentation displayed in the `cadet-frontend`. ``doc/jsdoc/libraries/``. The script `jsdoc` provides an installation command to deploy the documentation via `scp` on a server: ``yarn jsdoc install`` +To update documentation displayed in autocomplete on the frontend, `js-slang` version needs to be bumped and `cadet-frontend` needs to be updated to use the new version. To add additional source versions or external libraries, the `targets` specified in `updateAutocompleteDocs.py` as well as the exported object in `src/editors/ace/docTooltip` need to be updated. + Testing ------- @@ -99,7 +101,7 @@ Error messages To enable verbose messages, have the statement ``"enable verbose";`` as the first line of your code. -There are two main kinds of error messages: those that occur at runtime and those that occur at parse time. +There are two main kinds of error messages: those that occur at runtime and those that occur at parse time. The first can be found in interpreter-errors.ts, while the second can be found in rules/. Each error subclass will have explain() and elaborate(). Displaying the error will always cause the first to be @@ -120,5 +122,5 @@ A common issue when developing modifications to js-slang is how to test it using $ cd js-slang $ yarn build $ cp -r dist ../cadet-frontend/node_modules/js-slang - + Then start frontend and the new js-slang will be used. diff --git a/docs/jsdoc/templates/template/tmpl/container.tmpl b/docs/jsdoc/templates/template/tmpl/container.tmpl index b423713ef..b7655a6cf 100644 --- a/docs/jsdoc/templates/template/tmpl/container.tmpl +++ b/docs/jsdoc/templates/template/tmpl/container.tmpl @@ -145,7 +145,9 @@

Constants

- +
+ +
@@ -156,7 +158,9 @@

Functions

- +
+ +
diff --git a/docs/source/CONCURRENCY/global.html b/docs/source/CONCURRENCY/global.html index fc59e706e..41924cc07 100644 --- a/docs/source/CONCURRENCY/global.html +++ b/docs/source/CONCURRENCY/global.html @@ -104,7 +104,8 @@

Functions

- +
+ @@ -260,8 +261,10 @@
Returns:
+
- +
+ @@ -420,8 +423,10 @@
Returns:
+
- +
+ @@ -578,6 +583,7 @@
Returns:
+
@@ -602,7 +608,7 @@

Predeclared names