From 988d381aad150431f1b8b46349526fb5379e0fa0 Mon Sep 17 00:00:00 2001 From: Michael Hoffmann <brennan.brisad@gmail.com> Date: Fri, 16 Oct 2020 02:09:29 +0200 Subject: [PATCH] Fix some small typos in the API documentation (#6751) While reading the docs I found a couple of small typos. --- doc/using-the-pandoc-api.md | 6 +++--- src/Text/Pandoc/Class/PandocMonad.hs | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/using-the-pandoc-api.md b/doc/using-the-pandoc-api.md index dbedefaa2..df9380313 100644 --- a/doc/using-the-pandoc-api.md +++ b/doc/using-the-pandoc-api.md @@ -120,7 +120,7 @@ getVerbosity :: PandocMonad m => m Verbosity -- | Set the verbosity level. setVerbosity :: PandocMonad m => Verbosity -> m () --- Get the accomulated log messages (in temporal order). +-- Get the accumulated log messages (in temporal order). getLog :: PandocMonad m => m [LogMessage] getLog = reverse <$> getsCommonState stLog @@ -337,7 +337,7 @@ use `throwError`. In addition to errors, which stop execution of the conversion pipeline, one can generate informational messages. Use `report` from [Text.Pandoc.Class] to issue a `LogMessage`. -For a list of cosntructors for `LogMessage`, see +For a list of constructors for `LogMessage`, see [Text.Pandoc.Logging]. Note that each type of log message is associated with a verbosity level. The verbosity level (`setVerbosity`/`getVerbosity`) determines whether the report @@ -432,7 +432,7 @@ structure and calling this function. 1. Pandoc's parsers can exhibit pathological behavior on some inputs. So it is always a good idea to wrap uses of pandoc in a timeout function (e.g. `System.Timeout.timeout` from `base`) - to prevent DOS attacks. + to prevent DoS attacks. 2. If pandoc generates HTML from untrusted user input, it is always a good idea to filter the generated HTML through diff --git a/src/Text/Pandoc/Class/PandocMonad.hs b/src/Text/Pandoc/Class/PandocMonad.hs index 1903d73d8..374da161b 100644 --- a/src/Text/Pandoc/Class/PandocMonad.hs +++ b/src/Text/Pandoc/Class/PandocMonad.hs @@ -160,7 +160,7 @@ setVerbosity verbosity = getVerbosity :: PandocMonad m => m Verbosity getVerbosity = getsCommonState stVerbosity --- | Get the accomulated log messages (in temporal order). +-- | Get the accumulated log messages (in temporal order). getLog :: PandocMonad m => m [LogMessage] getLog = reverse <$> getsCommonState stLog