Skip to content

Commit c624581

Browse files
committed
Documentation for type-enclosing
1 parent ad8f579 commit c624581

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,26 @@ navigating through errors:
3838

3939
![Error navigation example](media/error-navigation.gif)
4040

41+
### Type Enclosings
42+
43+
`ocaml-eglot` displays the type of expression below the cursor and
44+
increases or decreases the enclosings of the expression or verbosity:
45+
46+
- `ocaml-eglot-type-enclosing` (<kbd>C-c</kbd> <kbd>C-t</kbd>)
47+
48+
And when a type is displayed, additional commands are possible:
49+
50+
- `ocaml-eglot-type-enclosing-increase-verbosity` (<kbd>C-c</kbd>
51+
<kbd>C-t</kbd>): to increase the verbosity of the type observed
52+
- `ocaml-eglot-type-enclosing-grow` (<kbd>C-↑</kbd>): to grow the
53+
expression
54+
- `ocaml-eglot-type-enclosing-shrink` (<kbd>C-↓</kbd>): to shrink the
55+
expression
56+
- `ocaml-eglot-type-enclosing-copy` (<kbd>C-w></kbd>): to copy the
57+
type expression to the _kill-ring_ (clipboard)
58+
59+
![Type Enclosings example](media/type-enclosing.gif)
60+
4161
### Jump to definition/declaration
4262

4363
OCaml-eglot provides a shortcut to quickly jump to the definition or

media/type-enclosing.gif

228 KB
Loading

0 commit comments

Comments
 (0)