Documentation fixes.

Author: qnikst

co-log-json/CHANGELOG.md

@@ -1,5 +1,5 @@
 # Revision history for co-log-json
 
-## 0.0.2.0 -- 2020-10-25
+## 0.0.1.0 -- 2020-11-11
 
 * First version.

co-log-json/co-log-json.cabal

@@ -14,7 +14,7 @@ description:
      * "Colog.Json.Action" — efficient function for dumping logs in the 
        following format.
 
-   By default it emits logs of the following format (pretty-printed for convenience):
+   By default it emits logs in the following format (pretty-printed for convenience):
 
    @
    { "namespace":"server.package" -- namespace for the component
@@ -34,17 +34,7 @@ description:
    The most interesting thing here is the field @data@ that can be used by the user
    to add additional structured info to the message.
 
-   There are some thigs that are not implemented:
-
-     * pretty-printing
-     * timestamps
-     * sending messages to remote services
-     * message colouring
-
-   All that functionality that be implemented by the external tools that the program
-   pipes messages to.
-
-bug-reports:         https://github.com/cheopslab/cheops-logger/issues
+bug-reports:         https://github.com/cheopslab/cheops-logger/issues/new?labels=co-log-json
 license:             MPL-2.0
 license-file:        LICENSE
 author:              Alexander Vershilov
@@ -82,12 +72,5 @@ library
     , co-log-core ^>=0.2
     , string-conv ^>=0.1
   hs-source-dirs:      src
-  ghc-options:         -Wall -Werror
+  ghc-options:         -Wall
   default-language:    Haskell2010
-
---test-suite co-log-structured-test
---  default-language:    Haskell2010
---  type:                exitcode-stdio-1.0
---  hs-source-dirs:      test
---  main-is:             MyLibTest.hs
---  build-depends:       base ^>=4.14.1.0

co-log-json/src/Colog/Json.hs

@@ -117,7 +117,7 @@ mkLogger action = LoggerEnv action Seq.empty
 -- combie it with the rest of the colog ecosystem.
 --
 -- @
--- 'Colog.Core.Action.cfilter' (\(sev, _) -> sev > 'Colog.Json.DebugS') 'unLogger' ctx
+-- 'Colog.Core.Action.cfilter' (\\(sev, _) -> sev > 'Colog.Json.DebugS') 'unLogger' ctx
 -- @
 unLogger :: LoggerEnv -> LogAction IO (Severity, LogStr)
 unLogger (LoggerEnv action st) = LogAction $ \(lvl, msg) -> do
@@ -172,6 +172,7 @@ addNamespace ns LoggerEnv{..} = LoggerEnv{context=context Seq.|> Segment ns, ..}
 -- detail and may change in the future.
 --
 -- 'LogStr' can be created is several ways:
+--
 --    * From the string literal using 'Data.String.IsString' interface
 --    * From the string like data that can be converted to text, using 'ls' function
 --    * From the type that has a 'Show' instance using 'showLS'