aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Maxime Dénès <mail@maximedenes.fr>2017-09-18 15:57:26 +0200
committerGravatar Maxime Dénès <mail@maximedenes.fr>2017-09-19 11:43:42 +0200
commit569e8f7601ee1484f8373320a102fa2ab026078c (patch)
tree465abcc07df14a2f39b50d216883adc0da273088
parent84accdaea3ce094cc5d0232107d3e2ea654a76c2 (diff)
Improve documentation of Status message.
-rw-r--r--dev/doc/xml-protocol.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/dev/doc/xml-protocol.md b/dev/doc/xml-protocol.md
index 127b4a6d2..cf7d205d8 100644
--- a/dev/doc/xml-protocol.md
+++ b/dev/doc/xml-protocol.md
@@ -291,7 +291,10 @@ Pseudocode for listing all of the goals in order: `rev (flat_map fst background)
### <a name="command-status">**Status(force: bool)**</a>
-CoqIDE typically sets `force` to `false`.
+Returns information about the current proofs. CoqIDE typically sends this
+message with `force = false` after each sentence, and with `force = true` if
+the user wants to force the checking of all proofs (wheels button). In terms of
+the STM API, `force` triggers a `Join`.
```html
<call val="Status"><bool val="${force}"/></call>
```