branch: externals/drepl
commit 37adae8929a38baacfca6b54df11f92cad3293e7
Author: Augusto Stoffel <[email protected]>
Commit: Augusto Stoffel <[email protected]>
Reformat readme
---
README.org | 153 ++++++++++++++++++++++++++++++++-----------------------------
1 file changed, 80 insertions(+), 73 deletions(-)
diff --git a/README.org b/README.org
index 3be2d4d8f3..4ad6a69739 100644
--- a/README.org
+++ b/README.org
@@ -80,79 +80,86 @@ message contains the following fields:
The following operations are defined:
-- =status= (interpreter notification): The interpreter indicates
- whether or not it is ready to receive a framed operation message.
-
- Parameters:
- - =status=: Either =ready= (subprocess is expecting a
- framed message) or =busy= (IO, if it occurs, should not be
- framed).
-
- Note: Some changes in the tracked state happen implicitly. Most
- importantly, when an editor request is sent, tracked state changes
- to =busy=.
-
-- =eval= (editor request). Evaluate some code, blocking until the
- computation is complete.
-
- Parameters:
- - =code=: The code to be evaluated
-
- Result: The response contains no data (that is, it includes only the
- original request id). The REPL should evaluate the code and print
- the result.
-
-- =complete= (editor request): Get completions at point.
-
- Parameters:
- - =code=: A code snippet containing the completion point.
- - =offset=: The offset (zero-based) from start of =code= to
- the point of completion.
-
- Response:
- - =candidates= (optional): A list of objects, each containing the
- following attributes.
- - =text=: The completed text, including the existing prefix.
- - =annot=: Annotation text to be displayed next to the candidate
- in the completion UI.
-
-- =checkinput= (editor request): Check if a continuation line is
- needed.
-
- Parameters:
- - =code= (string): A code snippet.
-
- Result:
- - =status=: One of =complete= (the code is valid),
- =incomplete= (the code is syntactically invalid, but may become so
- by adding more text) or =invalid= (there is a syntax error in the
- existing portion of code).
- - =indent= (optional): If present, this is the expected indentation
- of a continuation line, as a string.
- - =prompt=: The prompt of a continuation line.
-
-- =describe= (editor request): Obtain information on the symbol at
- point.
-
- Parameters:
- - =code=: A code snippet.
- - =offset=: An offset (zero-based) from start of =code= containing
- the symbol of interest.
-
- Result: The response may be empty (no information on the symbol) or
- as follows.
- - =name=: The symbol name.
- - =type= (optional): The symbol type or function signature.
- - =text= (optional): Free-form documentation on the symbol.
-
-- =setoptions= (editor request): Set configuration options. The
- parameters are arbitrary and interpreter-specific. The interpreter
- must send an empty response.
-
-- =getoptions= (interpreter notification). Indicates that the editor
- should send a =setoptions= request. Typically emitted when the
- interpreter is initialized but before printing the first prompt.
- Implicitly changes the tracked interpreter state to =ready=.
+*** =status= (interpreter notification)
+The interpreter indicates whether or not it is ready to receive a
+framed operation message.
+
+Parameters:
+- =status=: Either =ready= (subprocess is expecting a framed message)
+ or =busy= (IO, if it occurs, should not be framed).
+
+Note: Some changes in the tracked state happen implicitly. Most
+importantly, when an editor request is sent, tracked state changes to
+=busy=.
+
+*** =eval= (editor request)
+Evaluate some code, blocking until the computation is complete.
+
+Parameters:
+- =code=: The code to be evaluated
+
+Result: The response contains no data (that is, it includes only the
+original request id). The REPL should evaluate the code and print the
+result.
+
+*** =complete= (editor request)
+
+Get completions at point.
+
+Parameters:
+- =code=: A code snippet containing the completion point.
+- =offset=: The offset (zero-based) from start of =code= to
+ the point of completion.
+
+Response:
+- =candidates= (optional): A list of objects, each containing the
+ following attributes.
+ - =text=: The completed text, including the existing prefix.
+ - =annot=: Annotation text to be displayed next to the candidate
+ in the completion UI.
+
+*** =checkinput= (editor request)
+
+Check if a continuation line is needed.
+
+Parameters:
+- =code= (string): A code snippet.
+
+Result:
+- =status=: One of =complete= (the code is valid), =incomplete= (the
+ code is syntactically invalid, but may become so by adding more
+ text) or =invalid= (there is a syntax error in the existing portion
+ of code).
+- =indent= (optional): If present, this is the expected indentation of
+ a continuation line, as a string.
+- =prompt=: The prompt of a continuation line.
+
+*** =describe= (editor request)
+
+Obtain information on the symbol at point.
+
+Parameters:
+- =code=: A code snippet.
+- =offset=: An offset (zero-based) from start of =code= containing the
+ symbol of interest.
+
+Result: The response may be empty (no information on the symbol) or as
+follows.
+- =name=: The symbol name.
+- =type= (optional): The symbol type or function signature.
+- =text= (optional): Free-form documentation on the symbol.
+
+*** =setoptions= (editor request)
+
+Set configuration options. The parameters are arbitrary and
+interpreter-specific. The interpreter must send an empty response.
+
+*** =getoptions= (interpreter notification)
+
+Indicates that the editor should send a =setoptions= request.
+Typically emitted when the interpreter is initialized but before
+printing the first prompt. Implicitly changes the tracked interpreter
+state to =ready=.
** Why
