mirror of
https://github.com/dillonkearns/elm-pages-v3-beta.git
synced 2024-11-24 15:12:01 +03:00
Update doc comments.
This commit is contained in:
parent
ec9c995b88
commit
fb2c5be7ce
3
elm.json
3
elm.json
@ -12,7 +12,8 @@
|
||||
"OptimizedDecoder.Pipeline",
|
||||
"Pages.ImagePath",
|
||||
"Pages.PagePath",
|
||||
"Pages.StaticHttp",
|
||||
"DataSource",
|
||||
"DataSource.Http",
|
||||
"Pages.StaticFile",
|
||||
"Pages.Secrets",
|
||||
"Pages.Manifest",
|
||||
|
@ -1,9 +1,9 @@
|
||||
module DataSource exposing
|
||||
( map, succeed, fail
|
||||
( DataSource
|
||||
, map, succeed, fail
|
||||
, Body, emptyBody, stringBody, jsonBody
|
||||
, andThen, resolve, combine
|
||||
, map2, map3, map4, map5, map6, map7, map8, map9
|
||||
, DataSource
|
||||
)
|
||||
|
||||
{-| StaticHttp requests are an alternative to doing Elm HTTP requests the traditional way using the `elm/http` package.
|
||||
@ -35,8 +35,8 @@ in [this article introducing StaticHttp requests and some concepts around it](ht
|
||||
- Data that is specific to the logged-in user
|
||||
- Data that needs to be the very latest and changes often (for example, sports scores)
|
||||
|
||||
@docs Request, RequestDetails
|
||||
@docs get, request
|
||||
@docs DataSource
|
||||
|
||||
@docs map, succeed, fail
|
||||
|
||||
|
||||
@ -55,20 +55,6 @@ and describe your use case!
|
||||
|
||||
@docs map2, map3, map4, map5, map6, map7, map8, map9
|
||||
|
||||
|
||||
## Unoptimized Requests
|
||||
|
||||
Warning - use these at your own risk! It's highly recommended that you use the other request functions that make use of
|
||||
`zwilias/json-decode-exploration` in order to allow you to reduce down your JSON to only the values that are used by
|
||||
your decoders. This can significantly reduce download sizes for your StaticHttp requests.
|
||||
|
||||
@docs unoptimizedRequest
|
||||
|
||||
|
||||
### Expect for unoptimized requests
|
||||
|
||||
@docs Expect, expectString, expectUnoptimizedJson
|
||||
|
||||
-}
|
||||
|
||||
import Dict exposing (Dict)
|
||||
|
@ -4,7 +4,6 @@ module DataSource.Http exposing
|
||||
, Body, emptyBody, stringBody, jsonBody
|
||||
, unoptimizedRequest
|
||||
, Expect, expectString, expectUnoptimizedJson
|
||||
, andThen
|
||||
)
|
||||
|
||||
{-| StaticHttp requests are an alternative to doing Elm HTTP requests the traditional way using the `elm/http` package.
|
||||
|
@ -5,7 +5,9 @@ module Glob exposing
|
||||
|
||||
{-|
|
||||
|
||||
@docs Glob, atLeastOne, drop, extractMatches, fullFilePath, keep, literal, map, not, notOneOf, oneOf, recursiveWildcard, run, singleFile, succeed, toNonEmptyWithDefault, toPattern, toStaticHttp, wildcard, zeroOrMore
|
||||
@docs Glob, atLeastOne, extractMatches, fullFilePath, literal, map, not, notOneOf, oneOf, recursiveWildcard, run, singleFile, succeed, toNonEmptyWithDefault, toPattern, toStaticHttp, wildcard, zeroOrMore
|
||||
|
||||
@docs capture, ignore
|
||||
|
||||
-}
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user