Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove empty haddocks and remove empty comments. #1459

Draft
wants to merge 19 commits into
base: master
Choose a base branch
from
+768 −20
Draft

Remove empty haddocks and remove empty comments. #1459

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
8adccf8
Detect empty comments in isolation.
philderbeast Feb 12, 2023
a6f3b09
Add empty comment test file
philderbeast Feb 14, 2023
25ce756
Empty line tests; leading, trailing & double
philderbeast Jul 27, 2024
ab2a9f0
Add checks for single line >>> doctest comment
philderbeast Jul 31, 2024
5d59c9e
Update test expectations
philderbeast Jul 31, 2024
dd54168
Use helper in construction of Idea
philderbeast Jul 31, 2024
44fe67c
Add isCommentPragma
philderbeast Aug 3, 2024
e0eb345
Add isCommentHaddock
philderbeast Aug 3, 2024
89f527e
Very much WIP
philderbeast Aug 1, 2024
17352af
Add TODO comment
philderbeast Aug 2, 2024
c863c27
Need to sort comments by line
philderbeast Aug 2, 2024
fdd100e
Add isHaddockLeader
philderbeast Aug 2, 2024
65a87b1
Add classify comments
philderbeast Aug 2, 2024
4e1fc4f
Add scratch .test files in the root
philderbeast Aug 3, 2024
7e670a6
Include multi-line postfix haddock comments
philderbeast Aug 4, 2024
3328bf2
Check empty block haddocks separately
philderbeast Aug 4, 2024
0351986
Check empty blocks separately
philderbeast Aug 4, 2024
d5ffa47
Check for empty pragmas
philderbeast Aug 4, 2024
d6a0ccd
Add isHaddockDoctestWhitespace
philderbeast Aug 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add isCommentHaddock
  • Loading branch information
@philderbeast
philderbeast committed Aug 3, 2024
commit e0eb3458acb2f3adad3ade79f63d09045667410e
8 changes: 8 additions & 0 deletions src/GHC/Util/ApiAnnotation.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ module GHC.Util.ApiAnnotation (
, GHC.Util.ApiAnnotation.comments
, isCommentMultiline
, isCommentPragma
, isCommentHaddock
, pragmas
, flags
, languagePragmas
Expand Down Expand Up @@ -67,6 +68,13 @@ isCommentPragma (L _ (EpaComment (EpaBlockComment comm) _)) =
"{-#" `isPrefixOf` comm && "#-}" `isSuffixOf` comm
isCommentPragma _ = False

isCommentHaddock :: LEpaComment -> Bool
isCommentHaddock (L _ (EpaComment (EpaBlockComment comm) _)) =
"{- |" `isPrefixOf` comm && "-}" `isSuffixOf` comm
isCommentHaddock (L _ (EpaComment (EpaLineComment comm) _)) =
"-- |" `isPrefixOf` comm || "-- ^" `isPrefixOf` comm
isCommentHaddock _ = False

-- Pragmas have the form @{-# ...#-}@.
pragmas :: EpAnnComments -> [(LEpaComment, String)]
pragmas x =
Expand Down