+ documentation

haskell · Aug 29, 2024 · f202d4c · f202d4c
1 parent d52690d
commit f202d4c
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal.hs b/plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal.hs
@@ -368,6 +368,14 @@ hover ide _ msgParam = do
     dependencyName :: Dependency -> T.Text
     dependencyName dep = T.pack $ unPackageName $ depPkgName dep
 
+    -- | Removes version requirements like
+    -- `==1.0.0.0`, `>= 2.1.1` that could be included in
+    -- hover message. Assumes that the dependency consists
+    -- of alphanums with dashes in between. Ends with an alphanum.
+    --
+    -- Examples:
+    -- >>> filterVersion "imp-deps>=2.1.1"
+    -- "imp-deps"
     filterVersion :: T.Text -> Maybe T.Text
     filterVersion msg = getMatch (msg =~ regex)
       where