Include bubba suggestions

Co-Authored-By: bubba

Author: lukel97

hie-plugin-api/Haskell/Ide/Engine/PluginsIdeMonads.hs

@@ -212,8 +212,8 @@ type SymbolProvider = Uri -> IdeDeferM (IdeResult [DocumentSymbol])
 data FormattingType = FormatDocument
                     | FormatRange Range
 
--- |Formats the given Uri with the given options.
--- A formatting type can be given to either format the whole documetn or only a Range.
+-- | Formats the given Uri with the given options.
+-- A formatting type can be given to either format the whole document or only a Range.
 -- Fails if the formatter can not parse the source.
 -- Failing menas here that a IdeResultFail is returned.
 -- This can be used to display errors to the user, unless the error is an Internal one.

src/Haskell/Ide/Engine/Plugin/Brittany.hs

@@ -36,7 +36,7 @@ brittanyDescriptor plId = PluginDescriptor
   , pluginFormattingProvider = Just provider
   }
 
--- |Formatter provider of Brittany.
+-- | Formatter provider of Brittany.
 -- Formats the given source in either a given Range or the whole Document.
 -- If the provider fails an error is returned that can be displayed to the user.
 provider :: FormattingProvider
@@ -68,7 +68,7 @@ normalize (Range (Position sl _) (Position el _)) =
   -- Extend to the line below to replace newline character, as above
   Range (Position sl 0) (Position (el + 1) 0)
 
--- |Recursively search in every directory of the given filepath for brittany.yaml
+-- | Recursively search in every directory of the given filepath for brittany.yaml
 -- If no such file has been found, return Nothing.
 getConfFile :: FilePath -> IO (Maybe FilePath)
 getConfFile = findLocalConfigPath . takeDirectory

src/Haskell/Ide/Engine/Plugin/Floskell.hs

@@ -27,7 +27,7 @@ floskellDescriptor plId = PluginDescriptor
   , pluginFormattingProvider = Just provider
   }
 
--- |Format provider of Floskell.
+-- | Format provider of Floskell.
 -- Formats the given source in either a given Range or the whole Document.
 -- If the provider fails an error is returned that can be displayed to the user.
 provider :: FormattingProvider
@@ -46,7 +46,7 @@ provider uri typ _opts =
               Left  err -> return $ IdeResultFail (IdeError PluginError (T.pack err) Null)
               Right new -> return $ IdeResultOk [TextEdit range (T.decodeUtf8 (BS.toStrict new))]
 
--- |Find Floskell Config, user and system wide or provides a default style.
+-- | Find Floskell Config, user and system wide or provides a default style.
 -- Every directory of the filepath will be searched to find a user configuration.
 -- Also looks into places such as XDG_CONFIG_DIRECTORY<https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html>.
 -- This function may not throw an exception and returns a default config.