Skip to content

Commit

Permalink
Documentation for type-enclosing
Browse files Browse the repository at this point in the history
  • Loading branch information
xvw committed Jan 10, 2025
1 parent ad8f579 commit c942c57
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,26 @@ navigating through errors:

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

### Type Enclosings

`ocaml-eglot` displays the type of expression below the cursor and
increases or decreases the enclosings of the expression or verbosity:

- `ocaml-eglot-type-enclosing` (<kbd>C-c</kbd> <kbd>C-t</kbd>)

And when a type is displayed, additional commands are possible:

- `ocaml-eglot-type-enclosing-increase-verbosity` (<kbd>C-c</kbd>
<kbd>C-t</kbd>): to increase the verbosity of the type observed
- `ocaml-eglot-type-enclosing-grow` (<kbd>C-↑></kbd>): to grow the
expression
- `ocaml-eglot-type-enclosing-shrink` (<kbd>C-↓></kbd>): to shrink the
expression
- `ocaml-eglot-type-enclosing-copy` (<kbd>C-w></kbd>): to copy the
type expression to the _kill-ring_ (clipboard)

![Type Enclosings example](media/type-enclosing.gif)

### Jump to definition/declaration

OCaml-eglot provides a shortcut to quickly jump to the definition or
Expand Down
Binary file added media/type-enclosing.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c942c57

Please sign in to comment.