Skip to content

Commit f4153bd

Browse files
committed
Add explanation for preamble
1 parent b782e93 commit f4153bd

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/contributing/plugin-tutorial.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@ The plugins also make these tools much more accessible to all users of HLS.
2525

2626
## Preamble
2727

28+
This tutorial is a literate Haskell file that can be compiled.
29+
As such, we list the imports, extensions etc... necessary for compilation.
30+
31+
Please just skip over this `import` section, if you are only interested in the tutorial!
32+
2833
```haskell
2934
{-# LANGUAGE OverloadedStrings #-}
3035
{-# LANGUAGE DerivingStrategies #-}
@@ -403,7 +408,11 @@ The plugin code additionally contains advanced concepts, such as `Rules`.
403408

404409
I hope this has given you a taste of how easy and joyful it is to write plugins for HLS. If you are looking for contribution ideas, here are some good ones listed in the HLS [issue tracker](https://github.com/haskell/haskell-language-server/issues).
405410

411+
<details>
412+
<summary>Placeholder Main, unused</summary>
413+
406414
```haskell
407415
main :: IO ()
408416
main = putStrLn "Just here to silence the error!"
409417
```
418+
</details>

0 commit comments

Comments
 (0)