Skip to content

Commit 6d49b34

Browse files
author
Zdeno Osina
authored
Fix typos in documentation (#3274)
1 parent 595c527 commit 6d49b34

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

docs/contributing/contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ See the [tutorial](./plugin-tutorial.md) on writing a plugin in HLS.
196196

197197
When ghcide is built with the `ekg` flag, HLS opens a metrics server on port 8999 exposing GC and ghcide metrics. The ghcide metrics currently exposed are:
198198

199-
- `ghcide.values_count`- count of build results in the store
199+
- `ghcide.values_count` - count of build results in the store
200200
- `ghcide.database_count` - count of build keys in the store (these two would be the same in the absence of GC)
201201
- `ghcide.build_count` - build count. A key is GC'ed if it is dirty and older than 100 builds
202202
- `ghcide.dirty_keys_count` - non transitive count of dirty build keys

docs/contributing/plugin-tutorial.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,14 @@ Plugins are "linked" in the `HlsPlugins` module, so we will need to add our plug
8989
idePlugins = pluginDescToIdePlugins allPlugins
9090
where
9191
allPlugins =
92-
[ GhcIde.descriptor "ghcide"
93-
, Pragmas.descriptor "pragmas"
92+
[ GhcIde.descriptor "ghcide"
93+
, Pragmas.descriptor "pragmas"
9494
, Floskell.descriptor "floskell"
9595
, Fourmolu.descriptor "fourmolu"
96-
, Ormolu.descriptor "ormolu"
96+
, Ormolu.descriptor "ormolu"
9797
, StylishHaskell.descriptor "stylish-haskell"
9898
, Retrie.descriptor "retrie"
99-
, Brittany.descriptor "brittany"
99+
, Brittany.descriptor "brittany"
100100
, Eval.descriptor "eval"
101101
]
102102
```
@@ -271,7 +271,7 @@ runImportCommand _lspFuncs _state (ImportCommandParams edit) = do
271271

272272
The code lens provider implements all the steps of the algorithm described earlier:
273273

274-
> 1. Request the type checking artefacts from the ghcide subsystem
274+
> 1. Request the type checking artefacts from the ghcide subsystem
275275
> 2. Extract the actual import lists from the type checked AST,
276276
> 3. Ask GHC to produce the minimal import lists for this AST,
277277
> 4. For every import statement without a explicit import list, find out what's the minimal import list, and produce a code lens to display it together with a diff to graft the import list in.
@@ -392,5 +392,4 @@ However integrating the plugin in haskell-language-server itself will need some
392392
The full code as used in this tutorial, including imports, can be found in [this Gist](https://gist.github.com/pepeiborra/49b872b2e9ad112f61a3220cdb7db967) as well as in this [branch](https://github.com/pepeiborra/ide/blob/imports-lens/src/Ide/Plugin/ImportLens.hs)
393393

394394
I hope this has given you a taste of how easy and joyful it is to write plugins for HLS.
395-
If you are looking for ideas for contributing, here are some cool ones found in the HLS issue tracker:
396-
- https://github.com/haskell/haskell-language-server/issues?q=is%3Aopen+is%3Aissue+label%3A%22type%3A+possible+new+plugin%22
395+
If you are looking for ideas for contributing, here are some cool ones found in the HLS [issue tracker](https://github.com/haskell/haskell-language-server/issues?q=is%3Aopen+is%3Aissue+label%3A%22type%3A+possible+new+plugin%22).

0 commit comments

Comments
 (0)