From: razetime <rraghu.11502@gmail.com>
Date: Mon, 19 Feb 2024 15:37:42 +0000 (+0800)
Subject: help.handbook: add convention for destructors
X-Git-Url: https://gitweb.factorcode.org/gitweb.cgi?p=factor.git;a=commitdiff_plain;h=6fadc243bc0dd6f90f6d22f6132e42c7f45f29ba

help.handbook: add convention for destructors
---

diff --git a/basis/help/handbook/handbook.factor b/basis/help/handbook/handbook.factor
index 03dd35fd62..73c6854870 100644
--- a/basis/help/handbook/handbook.factor
+++ b/basis/help/handbook/handbook.factor
@@ -54,6 +54,7 @@ $nl
     { { $snippet { $emphasis "foo" } "!" } { "a variant of " { $snippet "foo" } " which mutates one of its arguments" } { { $link append! } } }
     { { $snippet "?" { $emphasis "foo" } } { "conditionally performs " { $snippet { $emphasis "foo" } } } { { $links ?nth } } }
     { { $snippet "<" { $emphasis "foo" } ">" } { "creates a new " { $snippet "foo" } } { { $link <array> } } }
+    { { $snippet ">" { $emphasis "foo" } "<" } { "destroys an object of class " { $snippet "foo" } ", usually unpacking its data" } { { $link >slice< } } }
     { { $snippet ">" { $emphasis "foo" } } { "converts the top of the stack into a " { $snippet "foo" } } { { $link >array } } }
     { { $snippet { $emphasis "foo" } ">" { $emphasis "bar" } } { "converts a " { $snippet "foo" } " into a " { $snippet "bar" } } { { $link number>string } } }
     { { $snippet "new-" { $emphasis "foo" } } { "creates a new " { $snippet "foo" } ", taking some kind of parameter from the stack which determines the type of the object to be created" } { { $link new-sequence } ", " { $link new-lexer } ", " { $link new } } }