Add documentation for StrippedEvent
parent
6783186c18
commit
693124aa15
|
@ -124,6 +124,7 @@ docs :
|
|||
, room : TypeDocs
|
||||
, settings : TypeDocs
|
||||
, stateManager : TypeDocs
|
||||
, strippedEvent : TypeDocs
|
||||
, timeline : TypeDocs
|
||||
, timelineFilter : TypeDocs
|
||||
, unsigned : TypeDocs
|
||||
|
@ -206,6 +207,12 @@ docs =
|
|||
, "Instead of making the user loop through the room's timeline of events, the StateManager offers the user a dictionary-like experience to navigate through the Matrix room state."
|
||||
]
|
||||
}
|
||||
, strippedEvent =
|
||||
{ name = "StrippedEvent"
|
||||
, description =
|
||||
[ "The StrippedEvent is a simplified Matrix event that contains no metadata."
|
||||
]
|
||||
}
|
||||
, timeline =
|
||||
{ name = "Timeline"
|
||||
, description =
|
||||
|
|
|
@ -11,6 +11,7 @@ The stripped event is a simple Matrix event that does not contain any metadata.
|
|||
|
||||
-}
|
||||
|
||||
import Internal.Config.Text as Text
|
||||
import Internal.Tools.Json as Json
|
||||
|
||||
|
||||
|
@ -21,8 +22,8 @@ type alias StrippedEvent =
|
|||
coder : Json.Coder StrippedEvent
|
||||
coder =
|
||||
Json.object2
|
||||
{ name = Debug.todo "Needs name"
|
||||
, description = Debug.todo "Needs description"
|
||||
{ name = Text.docs.strippedEvent.name
|
||||
, description = Text.docs.strippedEvent.description
|
||||
, init = StrippedEvent
|
||||
}
|
||||
(Json.field.required
|
||||
|
|
Loading…
Reference in New Issue