Skip to content

Commit

Permalink
docs: fix toc & heading sorting
Browse files Browse the repository at this point in the history
  • Loading branch information
@pbnj
pbnj committed Aug 16, 2023
1 parent 042010a commit e1b1e6a
Show file tree
Hide file tree
Showing 11 changed files with 242 additions and 238 deletions.
70 changes: 35 additions & 35 deletions doc/ale-elixir.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,37 @@ ALE Elixir Integration *ale-elixir-options*


===============================================================================
mix *ale-elixir-mix*

The `mix` linter is disabled by default, as it can be too expensive to run.
See `:help g:ale_linters`
credo *ale-elixir-credo*

Credo (https://github.com/rrrene/credo)

g:ale_elixir_mix_options *g:ale_elixir_mix_options*
*b:ale_elixir_mix_options*
Type: |String|
Default: `'mix'`
g:ale_elixir_credo_strict *g:ale_elixir_credo_strict*

Type: |Integer|
Default: `0`

This variable can be changed to specify the mix executable.
Tells credo to run in strict mode or suggest mode. Set variable to 1 to
enable --strict mode.


===============================================================================
mix_format *ale-elixir-mix-format*
g:ale_elixir_credo_config_file *g:ale_elixir_credo_config_file*

g:ale_elixir_mix_format_options *g:ale_elixir_mix_format_options*
*b:ale_elixir_mix_format_options*
Type: |String|
Default: `''`

Tells credo to use a custom configuration file.

This variable can be changed to specify the mix options passed to the
mix_format fixer

===============================================================================
cspell *ale-elixir-cspell*

See |ale-cspell-options|


===============================================================================
gitleaks *ale-elixir-gitleaks*

See |ale-gitleaks-options|


===============================================================================
Expand Down Expand Up @@ -77,37 +82,32 @@ g:ale_elixir_elixir_ls_config *g:ale_elixir_elixir_ls_config*


===============================================================================
credo *ale-elixir-credo*

Credo (https://github.com/rrrene/credo)

g:ale_elixir_credo_strict *g:ale_elixir_credo_strict*

Type: |Integer|
Default: `0`

Tells credo to run in strict mode or suggest mode. Set variable to 1 to
enable --strict mode.
mix *ale-elixir-mix*

The `mix` linter is disabled by default, as it can be too expensive to run.
See `:help g:ale_linters`

g:ale_elixir_credo_config_file *g:ale_elixir_credo_config_file*

g:ale_elixir_mix_options *g:ale_elixir_mix_options*
*b:ale_elixir_mix_options*
Type: |String|
Default: `''`
Default: `'mix'`

Tells credo to use a custom configuration file.

This variable can be changed to specify the mix executable.

===============================================================================
cspell *ale-elixir-cspell*

See |ale-cspell-options|
===============================================================================
mix_format *ale-elixir-mix-format*

g:ale_elixir_mix_format_options *g:ale_elixir_mix_format_options*
*b:ale_elixir_mix_format_options*
Type: |String|
Default: `''`

===============================================================================
gitleaks *ale-elixir-gitleaks*

See |ale-gitleaks-options|
This variable can be changed to specify the mix options passed to the
mix_format fixer


===============================================================================
Expand Down
128 changes: 64 additions & 64 deletions doc/ale-haskell.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,18 @@ g:ale_haskell_brittany_executable *g:ale_haskell_brittany_executable*
This variable can be changed to use a different executable for brittany.


===============================================================================
cabal-ghc *ale-haskell-cabal-ghc*

g:ale_haskell_cabal_ghc_options *g:ale_haskell_cabal_ghc_options*
*b:ale_haskell_cabal_ghc_options*
Type: |String|
Default: `'-fno-code -v0'`

This variable can be changed to modify flags given to ghc through cabal
exec.


===============================================================================
cspell *ale-haskell-cspell*

Expand All @@ -30,6 +42,26 @@ g:ale_haskell_floskell_executable *g:ale_haskell_floskell_executable*
This variable can be changed to use a different executable for floskell.


===============================================================================
fourmolu *ale-haskell-fourmolu*

g:ale_haskell_fourmolu_executable *g:ale_haskell_fourmolu_executable*
*b:ale_haskell_fourmolu_executable*
Type: |String|
Default: `'fourmolu'`

This variable can be changed to use a different executable for fourmolu.


g:ale_haskell_fourmolu_options *g:ale_haskell_fourmolu_options*
*b:ale_haskell_fourmolu_options*
Type: |String|
Default: `''`

This variable can be used to pass extra options to the underlying fourmolu
executable.


===============================================================================
ghc *ale-haskell-ghc*

Expand Down Expand Up @@ -58,18 +90,6 @@ gitleaks *ale-haskell-gitleaks*
See |ale-gitleaks-options|


===============================================================================
cabal-ghc *ale-haskell-cabal-ghc*

g:ale_haskell_cabal_ghc_options *g:ale_haskell_cabal_ghc_options*
*b:ale_haskell_cabal_ghc_options*
Type: |String|
Default: `'-fno-code -v0'`

This variable can be changed to modify flags given to ghc through cabal
exec.


===============================================================================
hdevtools *ale-haskell-hdevtools*

Expand Down Expand Up @@ -105,6 +125,18 @@ g:ale_haskell_hfmt_executable *g:ale_haskell_hfmt_executable*
This variable can be changed to use a different executable for hfmt.


===============================================================================
hie *ale-haskell-hie*

g:ale_haskell_hie_executable *g:ale_haskell_hie_executable*
*b:ale_haskell_hie_executable*
Type: |String|
Default: `'hie'`

This variable can be changed to use a different executable for the haskell
ide engine. i.e. `'hie-wrapper'`


===============================================================================
hindent *ale-haskell-hindent*

Expand Down Expand Up @@ -162,6 +194,26 @@ g:ale_haskell_hls_config *g:ale_haskell_hls_config*
https://haskell-language-server.readthedocs.io/en/latest/configuration.html#language-specific-server-options


===============================================================================
ormolu *ale-haskell-ormolu*

g:ale_haskell_ormolu_executable *g:ale_haskell_ormolu_executable*
*b:ale_haskell_ormolu_executable*
Type: |String|
Default: `'ormolu'`

This variable can be changed to use a different executable for ormolu.


g:ale_haskell_ormolu_options *g:ale_haskell_ormolu_options*
*b:ale_haskell_ormolu_options*
Type: |String|
Default: `''`

This variable can be used to pass extra options to the underlying ormolu
executable.


===============================================================================
stack-build *ale-haskell-stack-build*

Expand Down Expand Up @@ -198,57 +250,5 @@ g:ale_haskell_stylish_haskell_executable
This variable can be changed to use a different executable for stylish-haskell.


===============================================================================
hie *ale-haskell-hie*

g:ale_haskell_hie_executable *g:ale_haskell_hie_executable*
*b:ale_haskell_hie_executable*
Type: |String|
Default: `'hie'`

This variable can be changed to use a different executable for the haskell
ide engine. i.e. `'hie-wrapper'`


===============================================================================
ormolu *ale-haskell-ormolu*

g:ale_haskell_ormolu_executable *g:ale_haskell_ormolu_executable*
*b:ale_haskell_ormolu_executable*
Type: |String|
Default: `'ormolu'`

This variable can be changed to use a different executable for ormolu.


g:ale_haskell_ormolu_options *g:ale_haskell_ormolu_options*
*b:ale_haskell_ormolu_options*
Type: |String|
Default: `''`

This variable can be used to pass extra options to the underlying ormolu
executable.


===============================================================================
fourmolu *ale-haskell-fourmolu*

g:ale_haskell_fourmolu_executable *g:ale_haskell_fourmolu_executable*
*b:ale_haskell_fourmolu_executable*
Type: |String|
Default: `'fourmolu'`

This variable can be changed to use a different executable for fourmolu.


g:ale_haskell_fourmolu_options *g:ale_haskell_fourmolu_options*
*b:ale_haskell_fourmolu_options*
Type: |String|
Default: `''`

This variable can be used to pass extra options to the underlying fourmolu
executable.


===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
Loading

0 comments on commit e1b1e6a

Please sign in to comment.