fix(pylsp): elaborate configuration example (#2037)

See #1116, #1880, #1951, etc.

1 files changed, 19 insertions, 2 deletions

diff --git a/lua/lspconfig/server_configurations/pylsp.lua b/lua/lspconfig/server_configurations/pylsp.lua
index 7284fac4..2081d7b6 100644
--- a/lua/lspconfig/server_configurations/pylsp.lua
+++ b/lua/lspconfig/server_configurations/pylsp.lua
@@ -22,8 +22,25 @@ https://github.com/python-lsp/python-lsp-server
 
 A Python 3.6+ implementation of the Language Server Protocol.
 
-The language server can be installed via `pipx install 'python-lsp-server[all]'`.
-Further instructions can be found in the [project's README](https://github.com/python-lsp/python-lsp-server).
+See the [project's README](https://github.com/python-lsp/python-lsp-server) for installation instructions.
+
+Configuration options are documented [here](https://github.com/python-lsp/python-lsp-server/blob/develop/CONFIGURATION.md).
+In order to configure an option, it must be translated to a nested Lua table and included in the `settings` aregument to the `setup{}` function.
+For example, in order to set the `pylsp.plugins.pycodestyle.ignore` option:
+```lua
+require'lspconfig'.pylsp.setup{
+  settings = {
+    pylsp = {
+      plugins = {
+        pycodestyle = {
+          ignore = {'W391'},
+          maxLineLength = 100
+        }
+      }
+    }
+  }
+}
+```
 
 Note: This is a community fork of `pyls`.
     ]],