diff --git a/doc/CONVENTIONS.md b/doc/CONVENTIONS.md index 99005af7a..abb6ab9b6 100644 --- a/doc/CONVENTIONS.md +++ b/doc/CONVENTIONS.md @@ -56,22 +56,24 @@ A package is initialized in a function with name `/init-xxx` where: A lot of languages can interact with a REPL. To help keeping a consistent behavior between those languages the following conventions should be followed: -- ` m s` is the prefix for sending code. +- ` m` is the prefix for sending code if there is any conflict with +other bindings then ` m s` is the prefered prefix. This allows fast +interaction with the REPL whenever it is possible. - lower case key bindings keep the focus on the current buffer - upper case key bindings move the focus to the REPL buffer - Key | Description -------------------|------------------------------------------------------------ -m s b | send buffer -m s B | send buffer and switch to REPL -m s d | first key to send buffer and switch to REPL to debug (step) -m s D | second key to send buffer and switch to REPL to debug (step) -m s f | send function -m s F | send function and switch to REPL -m s l | send line -m s L | send line and switch to REPL -m s r | send region -m s R | send region and switch to REPL + Key | Description +--------------------|------------------------------------------------------------ +m (s) b | send buffer +m (s) B | send buffer and switch to REPL +m (s) d | first key to send buffer and switch to REPL to debug (step) +m (s) D | second key to send buffer and switch to REPL to debug (step) +m (s) f | send function +m (s) F | send function and switch to REPL +m (s) l | send line +m (s) L | send line and switch to REPL +m (s) r | send region +m (s) R | send region and switch to REPL Note: we don't distinguish between the file and the buffer. @@ -88,7 +90,7 @@ common actions that we can unite under the same key bindings: ------------------|------------------------------------------------------------ m t a | execute all the tests of the current project m t b | execute all the tests of the current buffer -m t f | execute the current test (function) +m t t | execute the current test (thing at point, function) Note: we don't distinguish between the file and the buffer. We can implement an auto-save of the buffer before executing the tests.