From 26bb6b9b3e8404b75fbc5838a8b98a105140caf5 Mon Sep 17 00:00:00 2001 From: Brendan Hansen Date: Mon, 10 Apr 2023 12:24:40 -0500 Subject: [PATCH] added: documentation for pair --- core/container/pair.onyx | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/core/container/pair.onyx b/core/container/pair.onyx index dce8bc89..9f02bc2d 100644 --- a/core/container/pair.onyx +++ b/core/container/pair.onyx @@ -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; -- 2.25.1