Fix documentation standards
parent
6f42916a19
commit
21dfa1e77f
19
elm.json
19
elm.json
|
@ -5,6 +5,25 @@
|
||||||
"license": "EUPL-1.1",
|
"license": "EUPL-1.1",
|
||||||
"version": "2.1.0",
|
"version": "2.1.0",
|
||||||
"exposed-modules": [
|
"exposed-modules": [
|
||||||
|
"Internal.Config.Default",
|
||||||
|
"Internal.Config.Leaks",
|
||||||
|
"Internal.Config.Log",
|
||||||
|
"Internal.Config.Phantom",
|
||||||
|
"Internal.Config.Text",
|
||||||
|
"Internal.Tools.DecodeExtra",
|
||||||
|
"Internal.Tools.EncodeExtra",
|
||||||
|
"Internal.Tools.Hashdict",
|
||||||
|
"Internal.Tools.Iddict",
|
||||||
|
"Internal.Tools.Json",
|
||||||
|
"Internal.Tools.Mashdict",
|
||||||
|
"Internal.Tools.Timestamp",
|
||||||
|
"Internal.Tools.VersionControl",
|
||||||
|
"Internal.Values.Context",
|
||||||
|
"Internal.Values.Envelope",
|
||||||
|
"Internal.Values.Event",
|
||||||
|
"Internal.Values.Settings",
|
||||||
|
"Internal.Values.StateManager",
|
||||||
|
"Internal.Values.Vault",
|
||||||
"Matrix",
|
"Matrix",
|
||||||
"Matrix.Event",
|
"Matrix.Event",
|
||||||
"Matrix.Settings"
|
"Matrix.Settings"
|
||||||
|
|
|
@ -48,6 +48,8 @@ accessToken =
|
||||||
"elm-sdk-placeholder-access-token-leaks"
|
"elm-sdk-placeholder-access-token-leaks"
|
||||||
|
|
||||||
|
|
||||||
|
{-| Complete set of all leaking values. Commonly using for testing purposes.
|
||||||
|
-}
|
||||||
allLeaks : Set String
|
allLeaks : Set String
|
||||||
allLeaks =
|
allLeaks =
|
||||||
Set.union
|
Set.union
|
||||||
|
|
|
@ -1,7 +1,4 @@
|
||||||
module Internal.Config.Log exposing
|
module Internal.Config.Log exposing (Log, log)
|
||||||
( Log, log
|
|
||||||
, caughtError, debug, error, info, securityWarn, warn
|
|
||||||
)
|
|
||||||
|
|
||||||
{-|
|
{-|
|
||||||
|
|
||||||
|
@ -21,10 +18,19 @@ without triggering a major update.
|
||||||
-- @docs caughtError, debug, error, info, securityWarn, warn
|
-- @docs caughtError, debug, error, info, securityWarn, warn
|
||||||
|
|
||||||
|
|
||||||
|
{-| Common pattern for a log message. The log message consists of a log channel
|
||||||
|
like `debug`, `warn`, `error`, etc. and the content of the message.
|
||||||
|
|
||||||
|
These logs are completely optional: they can be ignored, they can be sent to the
|
||||||
|
console, or a dialog may be created that presents the log messages.
|
||||||
|
|
||||||
|
-}
|
||||||
type alias Log =
|
type alias Log =
|
||||||
{ channel : String, content : String }
|
{ channel : String, content : String }
|
||||||
|
|
||||||
|
|
||||||
|
{-| Create a log message of various log types.
|
||||||
|
-}
|
||||||
log :
|
log :
|
||||||
{ caughtError : String -> Log
|
{ caughtError : String -> Log
|
||||||
, debug : String -> Log
|
, debug : String -> Log
|
||||||
|
|
|
@ -81,6 +81,9 @@ accessTokenInvalid =
|
||||||
"Matrix API rejected access token as invalid"
|
"Matrix API rejected access token as invalid"
|
||||||
|
|
||||||
|
|
||||||
|
{-| Logs when the JSON decoder detects that an imported dictionary contained
|
||||||
|
duplicate keys.
|
||||||
|
-}
|
||||||
decodedDictSize : Int -> Int -> String
|
decodedDictSize : Int -> Int -> String
|
||||||
decodedDictSize from to =
|
decodedDictSize from to =
|
||||||
String.concat
|
String.concat
|
||||||
|
|
Loading…
Reference in New Issue