Skip to content

Commit 423843b

Browse files
authored
Add documentation for GHC-21926 (#514)
* Document GHC-21926 * Apply suggested title change * Explain alphanumeric characters * Reword the explanation of GHC-21926 * Add full stops and extension to GHC-21926 * Add suggested nuance
1 parent d526158 commit 423843b

File tree

7 files changed

+37
-0
lines changed

7 files changed

+37
-0
lines changed
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Version number or non-alphanumeric character in package name
3+
summary: Package imports may only consist of alphanumeric characters, and must omit the version.
4+
severity: error
5+
introduced: 9.6.1
6+
extension: PackageImports
7+
---
8+
9+
Version number or non-alphanumeric character in the package. Each of dash-separated components of package name must consist of alphanumeric characters (as defined by `Data.Char.isAlphaNum`), at least one of which is not a digit.
10+
Note that you will also see this error if the package name consists only of digits.
11+
The package name in this case refers to the one mentioned in an import when using the `PackageImports` language extension.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{-# LANGUAGE PackageImports #-}
2+
3+
module NonAlphanumericCharacterNameInPackage where
4+
5+
import "some-existing-package" Package.With.Non.Alphanumeric.Characters
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{-# LANGUAGE PackageImports #-}
2+
3+
module NonAlphanumericCharacterNameInPackage where
4+
5+
import "&*$^%!@()" Package.With.Non.Alphanumeric.Characters
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: Non-alphanumeric characters in the package name
3+
---
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{-# LANGUAGE PackageImports #-}
2+
3+
module VersionNameInPackage where
4+
5+
import "some-package" Package.With.Version
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{-# LANGUAGE PackageImports #-}
2+
3+
module VersionNameInPackage where
4+
5+
import "some-package-0.1.2.3" Package.With.Version
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: Version number in package name
3+
---

0 commit comments

Comments
 (0)