Skip to content

Commit c5b10f0

Browse files
gallaismattpolzin
andauthored
[ doc ] for the linear pair constructor (#1492)
Co-authored-by: Mathew Polzin <[email protected]>
1 parent 98d6749 commit c5b10f0

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

libs/prelude/Builtin.idr

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,12 @@ infix 5 #
7272
||| A pair type where each component is linear
7373
public export
7474
data LPair : Type -> Type -> Type where
75-
(#) : (1 _ : a) -> (1 _ : b) -> LPair a b
75+
||| A linear pair of elements.
76+
||| If you take one copy of the linear pair apart
77+
||| then you only get one copy of its left and right elements.
78+
||| @ a the left element of the pair
79+
||| @ b the right element of the pair
80+
(#) : (1 _ : a) -> (1 _ : b) -> LPair a b
7681

7782
namespace DPair
7883
||| Dependent pairs aid in the construction of dependent types by providing

0 commit comments

Comments
 (0)