Bump argo submodule to include docs for method results

.github/ci.sh

@@ -147,6 +147,10 @@ test_rpc() {
   ./cry rpc-test
 }
 
+check_rpc_docs() {
+  ./cry rpc-docs
+}
+
 bundle_files() {
   doc=dist/share/doc/cryptol
   lib=dist/share/cryptol

.github/workflows/ci.yml

@@ -129,6 +129,9 @@ jobs:
       - shell: bash
         run: .github/ci.sh test_rpc
         if: runner.os != 'Windows'
+      - shell: bash
+        run: .github/ci.sh check_rpc_docs
+        if: runner.os != 'Windows'
 
       - if: matrix.ghc == '8.8.4'
         uses: actions/upload-artifact@v2

cry

@@ -21,6 +21,7 @@ Available commands:
   test                         Run some tests (may take a while)
   quick-test                   Like "test" but run fewer tests by default
   rpc-test                     Run RPC server tests
+  rpc-docs                     Check that the RPC documentation is up-to-date
   exe-path                     Print the location of the local executable
 EOM
 }
@@ -90,6 +91,12 @@ case $COMMAND in
     $DIR/cryptol-remote-api/run_rpc_tests.sh
     ;;
 
+  rpc-docs)
+    echo "Checking cryptol-remote-api docs (Cryptol.rst) are up-to-date with server"
+    DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+    $DIR/cryptol-remote-api/check_docs.sh
+    ;;
+
 
   help) show_usage && exit 0 ;;
 

cryptol-remote-api/check_docs.sh

@@ -0,0 +1,14 @@
+#! /bin/bash
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+cd $DIR/docs
+
+export CRYPTOL_SERVER=$(cabal v2-exec which cryptol-remote-api)
+if [[ ! -x "$CRYPTOL_SERVER" ]]; then
+  echo "could not locate cryptol-remote-api executable - try executing with cabal v2-exec"
+  exit 1
+fi
+
+$CRYPTOL_SERVER doc > TEMP.rst
+diff Cryptol.rst TEMP.rst

cryptol-remote-api/cryptol-eval-server/Main.hs

@@ -36,6 +36,8 @@ import qualified Argo.Doc as Doc
 import CryptolServer
     ( ServerState, moduleEnv, tcSolver, initialState, extendSearchPath, command, notification )
 import CryptolServer.Call ( call )
+import CryptolServer.Data.Expression ( Expression )
+import CryptolServer.Data.Type ( JSONSchema )
 import CryptolServer.EvalExpr
     ( evalExpressionDescr, evalExpression )
 import CryptolServer.ExtendSearchPath
@@ -90,7 +92,11 @@ evalServerDocs =
   [ Doc.Section "Summary" $ [ Doc.Paragraph
     [Doc.Text "A remote server for ",
      Doc.Link (Doc.URL "https://https://cryptol.net/") "Cryptol",
-     Doc.Text " that supports only type checking and evaluation of Cryptol code."]]]
+     Doc.Text " that supports only type checking and evaluation of Cryptol code."]]
+  , Doc.Section "Terms and Types"
+    [Doc.datatype @Expression,
+     Doc.datatype @JSONSchema]
+  ]
 
 description :: String
 description =

cryptol-remote-api/cryptol-remote-api/Main.hs

@@ -18,6 +18,8 @@ import CryptolServer.Call ( call, callDescr )
 import CryptolServer.Check ( check, checkDescr )
 import CryptolServer.ClearState
     ( clearState, clearStateDescr, clearAllStates, clearAllStatesDescr )
+import CryptolServer.Data.Expression ( Expression )
+import CryptolServer.Data.Type ( JSONSchema )
 import CryptolServer.EvalExpr
     ( evalExpression, evalExpressionDescr )
 import CryptolServer.ExtendSearchPath
@@ -47,7 +49,11 @@ serverDocs =
   [ Doc.Section "Summary" $ [ Doc.Paragraph
     [Doc.Text "An RCP server for ",
      Doc.Link (Doc.URL "https://https://cryptol.net/") "Cryptol",
-     Doc.Text " that supports type checking and evaluation of Cryptol code via the methods documented below."]]]
+     Doc.Text " that supports type checking and evaluation of Cryptol code via the methods documented below."]]
+  , Doc.Section "Terms and Types"
+    [Doc.datatype @Expression,
+     Doc.datatype @JSONSchema]
+  ]
 
 description :: String
 description =

cryptol-remote-api/docs/.gitignore

@@ -1 +1,2 @@
 _build/
+TEMP.rst