Skip to content

Commit e8c8790

Browse files
authored
Import fileAnIssue from Dhall.Docs.Util (#2547)
* Import fileAnIssue from Dhall.Docs.Util * Fix typo
1 parent 53585c9 commit e8c8790

File tree

2 files changed

+2
-21
lines changed

2 files changed

+2
-21
lines changed

dhall-docs/src/Dhall/Docs/Core.hs

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ import Dhall.Docs.Embedded
4444
import Dhall.Docs.Html
4545
import Dhall.Docs.Markdown
4646
import Dhall.Docs.Store
47+
import Dhall.Docs.Util (fileAnIssue)
4748
import Dhall.Parser
4849
( Header (..)
4950
, ParseError (..)
@@ -439,26 +440,6 @@ addHtmlExt :: Path Rel File -> Path Rel File
439440
addHtmlExt relFile =
440441
Data.Maybe.fromMaybe (fileAnIssue "addHtmlExt") $ Path.addExtension ".html" relFile
441442

442-
-- | If you're wondering the GitHub query params for issue creation:
443-
-- https://docs.github.com/en/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters
444-
fileAnIssue :: Text -> a
445-
fileAnIssue titleName =
446-
error $ "\ESC[1;31mError\ESC[0m Documentation generator bug\n\n" <>
447-
448-
"Explanation: This error message means that there is a bug in the " <>
449-
"Dhall Documentation generator. You didn't did anything wrong, but " <>
450-
"if you would like to see this problem fixed then you should report " <>
451-
"the bug at:\n\n" <>
452-
453-
"https://github.com/dhall-lang/dhall-haskell/issues/new?labels=dhall-docs,bug\n\n" <>
454-
455-
"explaining your issue and add \"" <> Data.Text.unpack titleName <> "\" as error code " <>
456-
"so we can find the proper location in the source code where the error happened\n\n" <>
457-
458-
"Please, also include your package in the issue. It can be in:\n\n" <>
459-
"* A compressed archive (zip, tar, etc)\n" <>
460-
"* A git repository, preferably with a commit reference"
461-
462443
{-| Generate all of the docs for a package. This function does all the `IO ()`
463444
related tasks to call `generateDocsPure`
464445
-}

dhall-docs/src/Dhall/Docs/Util.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ fileAnIssue titleName =
1212
error $ "\ESC[1;31mError\ESC[0m Documentation generator bug\n\n" <>
1313

1414
"Explanation: This error message means that there is a bug in the " <>
15-
"Dhall Documentation generator. You didn't did anything wrong, but " <>
15+
"Dhall Documentation generator. You didn't do anything wrong, but " <>
1616
"if you would like to see this problem fixed then you should report " <>
1717
"the bug at:\n\n" <>
1818

0 commit comments

Comments
 (0)