Add missing docs and add elm-review-documentation.

This commit is contained in:
Dillon Kearns 2022-10-04 16:38:43 -07:00
parent e81c3e1b42
commit 613f7df781
6 changed files with 23 additions and 9 deletions

View File

@ -13,6 +13,7 @@
"jfmengels/elm-review": "2.8.1", "jfmengels/elm-review": "2.8.1",
"jfmengels/elm-review-common": "1.2.1", "jfmengels/elm-review-common": "1.2.1",
"jfmengels/elm-review-debug": "1.0.6", "jfmengels/elm-review-debug": "1.0.6",
"jfmengels/elm-review-documentation": "2.0.1",
"jfmengels/elm-review-performance": "1.0.1", "jfmengels/elm-review-performance": "1.0.1",
"jfmengels/elm-review-unused": "1.1.21", "jfmengels/elm-review-unused": "1.1.21",
"mthadley/elm-review-unit": "2.0.1", "mthadley/elm-review-unit": "2.0.1",
@ -23,6 +24,7 @@
"elm/html": "1.0.0", "elm/html": "1.0.0",
"elm/parser": "1.1.0", "elm/parser": "1.1.0",
"elm/random": "1.0.0", "elm/random": "1.0.0",
"elm/regex": "1.0.0",
"elm/time": "1.0.0", "elm/time": "1.0.0",
"elm/virtual-dom": "1.0.3", "elm/virtual-dom": "1.0.3",
"elm-community/list-extra": "8.6.0", "elm-community/list-extra": "8.6.0",

View File

@ -11,6 +11,10 @@ when inside the directory containing this file.
-} -}
import Docs.NoMissing exposing (exposedModules, onlyExposed)
import Docs.ReviewAtDocs
import Docs.ReviewLinksAndSections
import Docs.UpToDateReadmeLinks
import NoDebug.Log import NoDebug.Log
import NoDebug.TodoOrToString import NoDebug.TodoOrToString
import NoExposingEverything import NoExposingEverything
@ -37,7 +41,14 @@ import Review.Rule as Rule exposing (Rule)
config : List Rule config : List Rule
config = config =
([ NoPrimitiveTypeAlias.rule ([ --Docs.NoMissing.rule
-- { document = onlyExposed
-- , from = exposedModules
-- }
Docs.ReviewLinksAndSections.rule
, Docs.ReviewAtDocs.rule
, Docs.UpToDateReadmeLinks.rule
, NoPrimitiveTypeAlias.rule
, NoExposingEverything.rule , NoExposingEverything.rule
, NoPrematureLetComputation.rule , NoPrematureLetComputation.rule
, NoImportingEverything.rule [] , NoImportingEverything.rule []

View File

@ -171,7 +171,7 @@ just the metadata.
(Decode.field "tags" (Decode.list Decode.string)) (Decode.field "tags" (Decode.list Decode.string))
If you wanted to use this to get this metadata for all blog posts in a folder, you could use If you wanted to use this to get this metadata for all blog posts in a folder, you could use
the [`DataSource`](DataSource) API along with [`DataSource.Glob`](DataSource.Glob). the [`DataSource`](DataSource) API along with [`DataSource.Glob`](DataSource-Glob).
import DataSource exposing (DataSource) import DataSource exposing (DataSource)
import DataSource.File as File import DataSource.File as File

View File

@ -1,10 +1,5 @@
module DataSource.Internal.Request exposing (request) module DataSource.Internal.Request exposing (request)
{-| Build a `DataSource.Http` request (analogous to [Http.request](https://package.elm-lang.org/packages/elm/http/latest/Http#request)).
This function takes in all the details to build a `DataSource.Http` request, but you can build your own simplified helper functions
with this as a low-level detail, or you can use functions like [DataSource.Http.get](#get).
-}
import DataSource exposing (DataSource) import DataSource exposing (DataSource)
import DataSource.Http exposing (Body, Expect) import DataSource.Http exposing (Body, Expect)

View File

@ -575,7 +575,7 @@ field name (Field fieldParser kind) (Form definitions parseFn toInitialValues) =
{-| Declare a hidden field for the form. {-| Declare a hidden field for the form.
Unlike [`field`](#field) declarations which are rendered using [`Form.ViewField`](Form-ViewField) Unlike [`field`](#field) declarations which are rendered using [`Form.FieldView`](Form-FieldView)
functions, `hiddenField` inputs are automatically inserted into the form when you render it. functions, `hiddenField` inputs are automatically inserted into the form when you render it.
You define the field's validations the same way as for `field`, with the You define the field's validations the same way as for `field`, with the

View File

@ -1,6 +1,7 @@
module Head.Seo exposing module Head.Seo exposing
( Common, Image, article, audioPlayer, book, profile, song, summary, summaryLarge, videoPlayer, website ( Common, Image, article, audioPlayer, book, profile, song, summary, summaryLarge, videoPlayer, website
, DateOrDateTime(..), dateOrDateTimeToString , dateOrDateTimeToString
, DateOrDateTime(..)
) )
{-| <https://ogp.me/#> {-| <https://ogp.me/#>
@ -50,6 +51,11 @@ with the `head` function that you pass to your Pages config (`Pages.application`
@docs Common, Image, article, audioPlayer, book, profile, song, summary, summaryLarge, videoPlayer, website @docs Common, Image, article, audioPlayer, book, profile, song, summary, summaryLarge, videoPlayer, website
## DateOrDateTime
@docs DateOrDateTime, dateOrDateTimeToString
-} -}
import Date import Date