Skip to content

Commit 58823e0

Browse files
gustywallymathieu
andcommitted
Add xml comments to Idiom bracket literals (#652)
Co-authored-by: Oskar Mathieu Gewalli <oskar@gewalli.se>
1 parent 94cea24 commit 58823e0

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

src/FSharpPlus/Builders.fs

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,21 @@ module GenericBuilders =
112112
static member ($) (Idiomatic, Ii) = id
113113
let inline idiomatic a b = (Idiomatic $ b) a
114114

115+
/// <summary>
116+
/// Marks the beginning of an idiom bracket (applicative style).
117+
/// </summary>
118+
/// <Remarks>
119+
/// Use Ii to mark the end of the idiom bracket.
120+
/// </Remarks>
115121
let inline iI x = (idiomatic << result) x
122+
123+
/// <summary>
124+
/// Marks the end of an idiom bracket (applicative style).
125+
/// </summary>
126+
/// <Remarks>
127+
/// Use iI to mark the beginning of the idiom bracket.
128+
/// </Remarks>
129+
let Ii = Ii
116130
type Idiomatic with static member inline ($) (Idiomatic, Ji) = fun xii -> join xii
117131
type Idiomatic with static member inline ($) (Idiomatic, J ) = fun fii x -> (Idiomatic $ x) (join fii)
118132

0 commit comments

Comments
 (0)