nit: comment revision, spellcheck, & reformatting

Close: #7262
Co-authored-by: emergenz <emergenz@users.noreply.github.com>
This commit is contained in:
Henrik Lissner 2023-07-22 18:12:19 +02:00
parent 9a80f783eb
commit 1cd2a287f5
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
5 changed files with 37 additions and 31 deletions

View file

@ -86,12 +86,11 @@ For LSP support the [[doom-module::tools lsp]] module must be enabled, along wit
[[doom-module:+lsp]] flag. By default, it supports [[doom-package:mspyls]] and [[doom-package:pyls]], in that order. With the
[[doom-module:+pyright]] flag, it will try Pyright first.
Each of these servers must be installed on your system via your OS package
manager or manually:
- [[https://pypi.org/project/python-language-server/][*pyls*]] can be installed with ~$ pip install python-language-server[all]~.
- *mspyls* can be installed by typing ~M-x lsp-install-server RET mspyls~.
- *pyright* can be installed with ~$ pip install pyright~ or ~$ npm i -g
pyright~.
An alternative LSP server can be used by installing them through the
[[cmd:][lsp-install-server]] command, or an external package manager. For example:
- To install [[https://pypi.org/project/python-language-server/][*pyls*]]: ~$ pip install python-language-server[all]~.
- To install *mspyls*: ~M-x lsp-install-server RET mspyls~.
- To install *pyright*: ~$ pip install pyright~ or ~$ npm i -g pyright~.
* TODO Usage
#+begin_quote
@ -107,7 +106,7 @@ To enable support for auto-formatting with black enable [[doom-module::editor fo
| Binding | Description |
|-------------------+----------------------------------|
| [[kbd:][<localleader> c c]] | ~Compile Cython buffer~ |
| [[kbd:][<localleader> i i]] | ~Insert mising imports~ |
| [[kbd:][<localleader> i i]] | ~Insert missing imports~ |
| [[kbd:][<localleader> i r]] | ~Remove unused imports~ |
| [[kbd:][<localleader> i s]] | ~Sort imports~ |
| [[kbd:][<localleader> i o]] | ~Optimize imports~ |
@ -135,8 +134,8 @@ To enable support for auto-formatting with black enable [[doom-module::editor fo
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
#+end_quote
This module has the following variables to set extra arguments to [[https://ipython.org/][ipython]] and
[[https://jupyter.org/][jupyter]] shells:
The arguments passed to the [[https://ipython.org/][ipython]] or [[https://jupyter.org/][jupyter]] shells can be altered through
these two variables:
#+begin_src emacs-lisp
;; in $DOOMDIR/config.el
(setq +python-ipython-repl-args '("-i" "--simple-prompt" "--no-color-info"))