added: documentation for pair
authorBrendan Hansen <brendan.f.hansen@gmail.com>
Mon, 10 Apr 2023 17:24:40 +0000 (12:24 -0500)
committerBrendan Hansen <brendan.f.hansen@gmail.com>
Mon, 10 Apr 2023 17:24:40 +0000 (12:24 -0500)
core/container/pair.onyx

index dce8bc890b53df943bc199c54aa4e8ff5d9664fd..9f02bc2d83ab8c5b790eff78aeb9b3dc55794dc4 100644 (file)
@@ -1,15 +1,14 @@
 package core
 
 
-//
-// A `Pair` represents a pair of values of heterogenous types.
-// This structure does not do much on its own; however, it
-// is useful because provides overloads for formatting, hashing
-// and equality. This means you can use a `Pair(T, R)` as a key
-// for a Map or Set out of the box, provided T and R are hashable
-// and equatable.
-//
-
+#doc """
+    A `Pair` represents a pair of values of heterogenous types.
+    This structure does not do much on its own; however, it
+    is useful because provides overloads for formatting, hashing
+    and equality. This means you can use a `Pair(T, R)` as a key
+    for a Map or Set out of the box, provided T and R are hashable
+    and equatable.
+"""
 @conv.Custom_Format.{#solidify _format {First_Type=First_Type, Second_Type=Second_Type}}
 Pair :: struct (First_Type: type_expr, Second_Type: type_expr) {
     first: First_Type;