From 569e8f7601ee1484f8373320a102fa2ab026078c Mon Sep 17 00:00:00 2001
From: Maxime Dénès
Date: Mon, 18 Sep 2017 15:57:26 +0200
Subject: Improve documentation of Status message.

---
 dev/doc/xml-protocol.md | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'dev')

diff --git a/dev/doc/xml-protocol.md b/dev/doc/xml-protocol.md
index 127b4a6d2d..cf7d205d8b 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>
 ```
-- 
cgit v1.2.3