Skip to content

Commit 721f021

Browse files
committed
Minor tweak to specifications.md
1 parent e612560 commit 721f021

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docs/mkDocs/docs/specifications.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
# Writing Specifications
22

3+
This section documents how you can actually annotate new or existing code with refinement types, leveraging
4+
the full power of LiquidHaskell.
5+
36
## Modules WITHOUT code
47

8+
The following section is slightly different depending on whether you are using the plugin (which you should!)
9+
or the legacy executable.
10+
11+
### (Plugin) Adding refinements for external modules
12+
13+
See the [plugin](plugin.md) section, which cointains a link to a walkthrough document that describes how to add
14+
refinements for external packages (cfr. **"Providing Specifications for Existing Packages"**)
15+
16+
### (Legacy executable) Adding refinements for external modules
17+
518
When checking a file `target.hs`, you can specify an _include_ directory by
619

720
liquid -i /path/to/include/ target.hs
@@ -24,7 +37,6 @@ See, for example, the contents of:
2437
+ The `.spec` mechanism is *only for external modules** without code,
2538
see below for standalone specifications for **internal** or **home** modules.
2639

27-
2840
## Modules WITH code: Data
2941

3042
Write the specification directly into the .hs or .lhs file,

0 commit comments

Comments
 (0)