diff options
| author | Lars-Dominik Braun <lars@6xq.net> | 2015-07-12 12:03:42 +0200 |
|---|---|---|
| committer | Lars-Dominik Braun <lars@6xq.net> | 2015-07-12 12:03:42 +0200 |
| commit | 25ef5b881b125bf372cc44067d352065fdbcf962 (patch) | |
| tree | 8fe3b3565246bbd7b8e8d5ad331ae0e26a96bd65 | |
| parent | ed218eeaec4d57723647a223acd2e39f068ebd53 (diff) | |
| download | pesto-25ef5b881b125bf372cc44067d352065fdbcf962.tar.gz pesto-25ef5b881b125bf372cc44067d352065fdbcf962.tar.bz2 pesto-25ef5b881b125bf372cc44067d352065fdbcf962.zip | |
Rewrite lint introduction
| -rw-r--r-- | src/Codec/Pesto/Lint.lhs | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/src/Codec/Pesto/Lint.lhs b/src/Codec/Pesto/Lint.lhs index 0d1c848..eac631f 100644 --- a/src/Codec/Pesto/Lint.lhs +++ b/src/Codec/Pesto/Lint.lhs @@ -13,15 +13,15 @@ Linting > import Codec.Pesto.Graph hiding (test) > import Codec.Pesto.Parse hiding (test) -Not every graph generated in the previous section is a useful recipe, since -some combinations of instructions just do not make sense. The linting test in -this section can detect common errors. Failing any of these tests does not -render a recipe invalid, but *useless*. Thus implementations must not create -such recipes. They may be accepted the user though. +Not every graph generated in the previous section is a useful recipe. Some +instruction sequences just do not make sense. The tests in this section can +detect those. Failing any of them does not render a stream of instructions or +graph invalid. They just does not describe a *useful* recipe. Thus +implementations must not generate or export such documents. However they should +accept input that fails any of the tests and warn the user about the failure. -Every lint test checks a single aspect of the graph. - -> lint nodes edges = concatMap (\f -> f nodes edges) lintTests +Additionally this section provides guidance on how to use the instructions +provided by the Pesto language properly. Metadata ++++++++ @@ -324,6 +324,10 @@ Appendix > | RangeFromLargerThanTo > deriving (Show, Eq, Ord) +Every lint test checks a single aspect of the graph. + +> lint nodes edges = concatMap (\f -> f nodes edges) lintTests + > lintTests = [ > rootIsResult > , referencesResolved |