emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs(format): reasoning for using +format/buffer

Browse source
This commit is contained in:
John Goff 2023-11-16 17:31:37 -05:00
parent 9da33cf9e7
commit c076b1237f
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
modules/editor/format/README.org
View file

@ -60,8 +60,9 @@ When this flag is enabled, you shouldn't need to do anything other than write
code and save it. code and save it.
** Without +onsave ** Without +onsave
Without the flag, formatting will only occur when either =apheleia-format-buffer= Without the flag, formatting will only occur when either =+format/buffer=
or =+format/buffer= is called. or =apheleia-format-buffer= is called. The difference between them is
=+format/buffer= will use a LSP server if configured and available.
* Configuration * Configuration
@ -113,7 +114,7 @@ This behaviour is controlled via [[var:+format-on-save-disabled-modes]] thus;
In this case, =emacs-lisp-mode=, =sql-mode=, =tex-mode= and =latex-mode= will not be In this case, =emacs-lisp-mode=, =sql-mode=, =tex-mode= and =latex-mode= will not be
formatted on save, but can still be formatted by manually invoking the commands formatted on save, but can still be formatted by manually invoking the commands
=apheleia-format-buffer= or =+format/buffer=. =+format/buffer= or =apheleia-format-buffer=.
** Disabling the LSP formatter ** Disabling the LSP formatter
If you are in a buffer with ~lsp-mode~ enabled and a server that supports If you are in a buffer with ~lsp-mode~ enabled and a server that supports