Skip to content

Commit 6e58684

Browse files
authored
Add missing errors placeholders (documentationjs#351)
1 parent 31e1624 commit 6e58684

12 files changed

+255
-0
lines changed

errors/CannotDefinePrimModules.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# `CannotDefinePrimModules` Error
2+
3+
## Example
4+
5+
```purescript
6+
module Prim where
7+
```
8+
9+
```purescript
10+
module Prim.ShortFailingExample where
11+
```
12+
13+
## Cause
14+
15+
The Prim namespace is reserved by the compiler.
16+
17+
## Fix
18+
19+
- Rename the module to move it outside the Prim namespace:
20+
21+
```diff
22+
-module Prim.ShortFailingExample where
23+
+module ShortFailingExample where
24+
```

errors/CycleInTypeClassDeclaration.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# `CycleInTypeClassDeclaration` Error
2+
3+
## Example
4+
5+
```purescript
6+
module ShortFailingExample where
7+
8+
...
9+
```
10+
11+
## Cause
12+
13+
Explain why a user might see this error.
14+
15+
## Fix
16+
17+
- Suggest possible solutions.
18+
19+
## Notes
20+
21+
- Additional notes.

errors/DuplicateInstance.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# `DuplicateInstance` Error
2+
3+
## Example
4+
5+
```purescript
6+
module ShortFailingExample where
7+
8+
...
9+
```
10+
11+
## Cause
12+
13+
Explain why a user might see this error.
14+
15+
## Fix
16+
17+
- Suggest possible solutions.
18+
19+
## Notes
20+
21+
- Additional notes.

errors/DuplicateTypeClass.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# `DuplicateTypeClass` Error
2+
3+
## Example
4+
5+
```purescript
6+
module ShortFailingExample where
7+
8+
...
9+
```
10+
11+
## Cause
12+
13+
Explain why a user might see this error.
14+
15+
## Fix
16+
17+
- Suggest possible solutions.
18+
19+
## Notes
20+
21+
- Additional notes.

errors/ErrorParsingCSTModule.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# `ErrorParsingCSTModule` Error
2+
3+
## Example
4+
5+
```purescript
6+
module ShortFailingExample where
7+
8+
...
9+
```
10+
11+
## Cause
12+
13+
Explain why a user might see this error.
14+
15+
## Fix
16+
17+
- Suggest possible solutions.
18+
19+
## Notes
20+
21+
- Additional notes.

errors/ExpectedTypeConstructor.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# `ExpectedTypeConstructor` Error
2+
3+
## Example
4+
5+
```purescript
6+
module ShortFailingExample where
7+
8+
...
9+
```
10+
11+
## Cause
12+
13+
Explain why a user might see this error.
14+
15+
## Fix
16+
17+
- Suggest possible solutions.
18+
19+
## Notes
20+
21+
- Additional notes.
+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# `ImplicitQualifiedImportReExport` Warning
2+
3+
## Example
4+
5+
```purescript
6+
module ShortFailingExample where
7+
8+
...
9+
```
10+
11+
## Cause
12+
13+
Explain why a user might see this warning.
14+
15+
## Fix
16+
17+
- Suggest possible solutions.
18+
19+
## Notes
20+
21+
- Additional notes.

errors/InvalidDerivedInstance.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# `InvalidDerivedInstance` Error
2+
3+
## Example
4+
5+
```purescript
6+
module ShortFailingExample where
7+
8+
...
9+
```
10+
11+
## Cause
12+
13+
Explain why a user might see this error.
14+
15+
## Fix
16+
17+
- Suggest possible solutions.
18+
19+
## Notes
20+
21+
- Additional notes.

errors/MissingKindDeclaration.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# `MissingKindDeclaration` Warning
2+
3+
## Example
4+
5+
```purescript
6+
module ShortFailingExample where
7+
8+
...
9+
```
10+
11+
## Cause
12+
13+
Explain why a user might see this warning.
14+
15+
## Fix
16+
17+
- Suggest possible solutions.
18+
19+
## Notes
20+
21+
- Additional notes.
+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# `MissingNewtypeSuperclassInstance` Warning
2+
3+
## Example
4+
5+
```purescript
6+
module ShortFailingExample where
7+
8+
...
9+
```
10+
11+
## Cause
12+
13+
Explain why a user might see this warning.
14+
15+
## Fix
16+
17+
- Suggest possible solutions.
18+
19+
## Notes
20+
21+
- Additional notes.

errors/UnusableDeclaration.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# `UnusableDeclaration` Error
2+
3+
## Example
4+
5+
```purescript
6+
module ShortFailingExample where
7+
8+
...
9+
```
10+
11+
## Cause
12+
13+
Explain why a user might see this error.
14+
15+
## Fix
16+
17+
- Suggest possible solutions.
18+
19+
## Notes
20+
21+
- Additional notes.
+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# `UnverifiableSuperclassInstance` Warning
2+
3+
## Example
4+
5+
```purescript
6+
module ShortFailingExample where
7+
8+
...
9+
```
10+
11+
## Cause
12+
13+
Explain why a user might see this warning.
14+
15+
## Fix
16+
17+
- Suggest possible solutions.
18+
19+
## Notes
20+
21+
- Additional notes.

0 commit comments

Comments
 (0)