[temporary] Improve documentation comments

serokell · Jan 27, 2023 · ffbf20f · ffbf20f
1 parent 297953e
commit ffbf20f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 5 deletions.
diff --git a/src/Xrefcheck/Scanners/Markdown.hs b/src/Xrefcheck/Scanners/Markdown.hs
@@ -5,8 +5,7 @@
 
 {-# OPTIONS_GHC -fno-warn-orphans #-}
 
--- | Markdown documents markdownScanner.
-
+-- | Scanner for gathering references to verify from Markdown documents.
 module Xrefcheck.Scanners.Markdown
   ( MarkdownConfig (..)
 

diff --git a/src/Xrefcheck/Scanners/Symlink.hs b/src/Xrefcheck/Scanners/Symlink.hs
@@ -3,10 +3,9 @@
  - SPDX-License-Identifier: MPL-2.0
  -}
 
--- | Symlink files symlinkScanner.
+-- | Scanner for gathering references to verify from symlinks.
 --
--- Verifies that the files referenced by symlinks exist in the repository.
-
+-- A symlink's reference corresponds to the file it points to.
 module Xrefcheck.Scanners.Symlink
   ( symlinkScanner
   , symlinkSupport