From fb2c5be7ceead37ca2d63deab7f7a2e27b809711 Mon Sep 17 00:00:00 2001 From: Dillon Kearns Date: Tue, 20 Apr 2021 14:24:36 -0700 Subject: [PATCH] Update doc comments. --- elm.json | 3 ++- src/DataSource.elm | 22 ++++------------------ src/DataSource/Http.elm | 1 - src/Glob.elm | 4 +++- 4 files changed, 9 insertions(+), 21 deletions(-) diff --git a/elm.json b/elm.json index 8431712e..6068ac8c 100644 --- a/elm.json +++ b/elm.json @@ -12,7 +12,8 @@ "OptimizedDecoder.Pipeline", "Pages.ImagePath", "Pages.PagePath", - "Pages.StaticHttp", + "DataSource", + "DataSource.Http", "Pages.StaticFile", "Pages.Secrets", "Pages.Manifest", diff --git a/src/DataSource.elm b/src/DataSource.elm index cbdb35fa..f83dd7a1 100644 --- a/src/DataSource.elm +++ b/src/DataSource.elm @@ -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) diff --git a/src/DataSource/Http.elm b/src/DataSource/Http.elm index 7f21d1b9..4441a0a4 100644 --- a/src/DataSource/Http.elm +++ b/src/DataSource/Http.elm @@ -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. diff --git a/src/Glob.elm b/src/Glob.elm index e7d78d1a..5d4599f1 100644 --- a/src/Glob.elm +++ b/src/Glob.elm @@ -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 -}