Copyright	disco team and contributors
Maintainer	byorgey@gmail.com
Safe Haskell	Safe-Inferred
Language	Haskell2010

Disco.Doc

Description

Built-in documentation.

Synopsis

data DocKey where
- PrimKey :: Prim -> DocKey
- OtherKey :: String -> DocKey
data RefType where
- Intro :: RefType
- Ref :: RefType
- URL :: RefType
data Reference = Reference {
- refType :: RefType
- ref :: String
}
mkRef :: String -> Reference
mkIntro :: String -> Reference
docMap :: Map DocKey (String, [Reference])

Documentation

data DocKey where Source #

Lookup keys for documentation.

Constructors

PrimKey :: Prim -> DocKey
OtherKey :: String -> DocKey

Instances

Instances details

Show DocKey Source #
Instance details Defined in Disco.Doc Methods showsPrec :: Int -> DocKey -> ShowS # show :: DocKey -> String # showList :: [DocKey] -> ShowS #
Eq DocKey Source #
Instance details Defined in Disco.Doc Methods (==) :: DocKey -> DocKey -> Bool # (/=) :: DocKey -> DocKey -> Bool #
Ord DocKey Source #
Instance details Defined in Disco.Doc Methods compare :: DocKey -> DocKey -> Ordering # (<) :: DocKey -> DocKey -> Bool # (<=) :: DocKey -> DocKey -> Bool # (>) :: DocKey -> DocKey -> Bool # (>=) :: DocKey -> DocKey -> Bool # max :: DocKey -> DocKey -> DocKey # min :: DocKey -> DocKey -> DocKey #

data RefType where Source #

An enumeration of different types of documentation references.

Constructors

Intro :: RefType	A reference to the Gentle Introduction (https:/disco-lang.readthedocs.ioenlatestintroduction/index.html)
Ref :: RefType	A reference to the Language Reference (https:/disco-lang.readthedocs.ioenlatestreference/index.html)
URL :: RefType	An arbitrary free-form URL

Instances

Instances details

Bounded RefType Source #
Instance details Defined in Disco.Doc Methods minBound :: RefType # maxBound :: RefType #
Enum RefType Source #
Instance details Defined in Disco.Doc Methods succ :: RefType -> RefType # pred :: RefType -> RefType # toEnum :: Int -> RefType # fromEnum :: RefType -> Int # enumFrom :: RefType -> [RefType] # enumFromThen :: RefType -> RefType -> [RefType] # enumFromTo :: RefType -> RefType -> [RefType] # enumFromThenTo :: RefType -> RefType -> RefType -> [RefType] #
Read RefType Source #
Instance details Defined in Disco.Doc Methods readsPrec :: Int -> ReadS RefType # readList :: ReadS [RefType] # readPrec :: ReadPrec RefType # readListPrec :: ReadPrec [RefType] #
Show RefType Source #
Instance details Defined in Disco.Doc Methods showsPrec :: Int -> RefType -> ShowS # show :: RefType -> String # showList :: [RefType] -> ShowS #
Eq RefType Source #
Instance details Defined in Disco.Doc Methods (==) :: RefType -> RefType -> Bool # (/=) :: RefType -> RefType -> Bool #
Ord RefType Source #
Instance details Defined in Disco.Doc Methods compare :: RefType -> RefType -> Ordering # (<) :: RefType -> RefType -> Bool # (<=) :: RefType -> RefType -> Bool # (>) :: RefType -> RefType -> Bool # (>=) :: RefType -> RefType -> Bool # max :: RefType -> RefType -> RefType # min :: RefType -> RefType -> RefType #

data Reference Source #

A reference for further reading.

Constructors

Reference
Fields refType :: RefType ref :: String

Instances

Instances details

Show Reference Source #
Instance details Defined in Disco.Doc Methods showsPrec :: Int -> Reference -> ShowS # show :: Reference -> String # showList :: [Reference] -> ShowS #
Eq Reference Source #
Instance details Defined in Disco.Doc Methods (==) :: Reference -> Reference -> Bool # (/=) :: Reference -> Reference -> Bool #
Ord Reference Source #
Instance details Defined in Disco.Doc Methods compare :: Reference -> Reference -> Ordering # (<) :: Reference -> Reference -> Bool # (<=) :: Reference -> Reference -> Bool # (>) :: Reference -> Reference -> Bool # (>=) :: Reference -> Reference -> Bool # max :: Reference -> Reference -> Reference # min :: Reference -> Reference -> Reference #

mkRef :: String -> Reference Source #

mkIntro :: String -> Reference Source #

docMap :: Map DocKey (String, [Reference]) Source #

A map storing documentation for various things that can be looked up with :doc. Each key is mapped to a short descriptive string, plus references for further reading.