Skip to content

Fix the FunctionBinding documentation #2290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 2, 2021
Merged

Fix the FunctionBinding documentation #2290

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
06eef91
Fix the FunctionBinding documentation
TristanCacqueray Aug 22, 2021
63e1071
Merge branch 'master' into function-binding-doc
sjakobi Sep 2, 2021
acb9946
Merge branch 'master' into function-binding-doc
sjakobi Sep 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions dhall/src/Dhall/Syntax.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,19 +371,19 @@ instance Bifunctor RecordField where
RecordField (k <$> s0) (first k value) (k <$> s1) (k <$> s2)
second = fmap

{-| Record the label of a function or a function-type expression

For example,

> λ({- A -} a {- B -} : {- C -} T) -> e

will be instantiated as follows:
* @functionBindingSrc0@ corresponds to the @A@ comment
* @functionBindingVariable@ is @a@
* @functionBindingSrc1@ corresponds to the @B@ comment
* @functionBindingSrc2@ corresponds to the @C@ comment
* @functionBindingAnnotation@ is @T@
-}
-- | Record the label of a function or a function-type expression
--
-- For example,
--
-- > λ({- A -} a {- B -} : {- C -} T) -> e
--
-- … will be instantiated as follows:
--
-- * @functionBindingSrc0@ corresponds to the @A@ comment
-- * @functionBindingVariable@ is @a@
-- * @functionBindingSrc1@ corresponds to the @B@ comment
-- * @functionBindingSrc2@ corresponds to the @C@ comment
-- * @functionBindingAnnotation@ is @T@
data FunctionBinding s a = FunctionBinding
{ functionBindingSrc0 :: Maybe s
, functionBindingVariable :: Text
Expand Down