Skip to content

Commit

Permalink
fix haddock
Browse files Browse the repository at this point in the history
  • Loading branch information
@owestphal
owestphal committed Nov 6, 2023
1 parent f69dc90 commit 11775a4
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/Test/IOTasks/Internal/Term.hs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
{-# LANGUAGE TupleSections #-}
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE TypeFamilyDependencies #-}
{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}
module Test.IOTasks.Internal.Term (
Term(..),
TermKind(..),
Expand Down Expand Up @@ -203,8 +202,10 @@ withSomeTerm (SomeTerm t) f = f t
data SomeTermK where
SomeTermK :: SomeTerm k -> SomeTermK

{- HLINT ignore withSomeTermK "Eta reduce" -}

Check failure on line 205 in src/Test/IOTasks/Internal/Term.hs

View workflow job for this annotation

GitHub Actions / Check Spelling 

`HLINT` is not a recognized word. (unrecognized-spelling)
-- eta-reduced version causes type error in Haddock workflow
withSomeTermK :: SomeTermK -> (forall (k :: TermKind) a. Typeable a => Term k a -> r) -> r
withSomeTermK (SomeTermK t) = withSomeTerm t
withSomeTermK (SomeTermK t) f = withSomeTerm t f
--
someTerm :: Typeable a => Term k a -> SomeTerm k
someTerm = SomeTerm
Expand Down

1 comment on commit 11775a4

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@check-spelling-bot Report

🔴 Please review

See the 📜action log for details.

Unrecognized words (1)

HLINT

Previously acknowledged words that are now absent GHC Line Linebreak Subterms :arrow_right:
To accept ✔️ these unrecognized words as correct and remove the previously acknowledged and now absent words, run the following commands

... in a clone of the [email protected]:fmidue/IOTasks.git repository
on the main branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.21/apply.pl' |
perl - 'https://github.com/fmidue/IOTasks/actions/runs/6773993039/attempts/1'
Available 📚 dictionaries could cover words not in the 📘 dictionary

This includes both expected items (55) from .github/actions/spelling/expect.txt and unrecognized words (1)

Dictionary Entries Covers
cspell:cpp/src/cpp.txt 30216 13
cspell:php/php.txt 2597 4
cspell:python/src/python/python-lib.txt 3873 3
cspell:node/node.txt 1768 3
cspell:mnemonics/src/mnemonics.txt 800 3

Consider adding them using (in .github/workflows/spelling.yml):

      with:
        extra_dictionaries:
          cspell:cpp/src/cpp.txt
          cspell:php/php.txt
          cspell:python/src/python/python-lib.txt
          cspell:node/node.txt
          cspell:mnemonics/src/mnemonics.txt

To stop checking additional dictionaries, add:

      with:
        check_extra_dictionaries: ''
Pattern suggestions ✂️ (1)

You could add these patterns to .github/actions/spelling/patterns.txt:

# Automatically suggested patterns
# hit-count: 28 file-count: 5
# IServiceProvider
\bI(?=(?:[A-Z][a-z]{2,})+\b)
Warnings (1)

See the 📜action log for details.

ℹ️ Warnings Count
ℹ️ candidate-pattern 3

See ℹ️ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

Please sign in to comment.