From 6b4b8ad13b174da2ed172d3eca2f6bd3553f7b71 Mon Sep 17 00:00:00 2001
From: kitty <nepeta@canaglie.net>
Date: Wed, 8 Apr 2026 16:03:51 +1000
Subject: some documentation

maybe reorganise the docs into topics
---
 sanctuary.fs | 11 ++---------
 1 file changed, 2 insertions(+), 9 deletions(-)

(limited to 'sanctuary.fs')

diff --git a/sanctuary.fs b/sanctuary.fs
index e161e6e..b7e5469 100644
--- a/sanctuary.fs
+++ b/sanctuary.fs
@@ -26,7 +26,7 @@
 : repeat  branch swap <resolve >resolve ; immediate compile-only
 
 : ?dup  dup 0<> if dup then ;
-: exit  [ hex ] c3 c, [ decimal ] ; immediate \ todo doc
+: exit  [ hex ] c3 c, [ decimal ] ; immediate compile-only
 
 : allot  dp +! ;
 
@@ -80,11 +80,6 @@ decimal
 : s>z  here -rot cmove, 0 c, ;
 
 \ DEFER {{{
-\ todo doc
-\ : defer  create ['] abort , does> @ execute ;
-\ : create  parse-name (header) latest ! ['] (create) compile, 0 , ;
-\ : does>  latest @ >body 2 + ['] (does>) over ! \ replace call loc
-\ 	( replace destination ) 11 + r> swap ! ;
 \ todo ['] abort → ['] ?defer or something (where ?defer yields an appropriate error)
 : defer  parse-name (header) latest !
 	['] (defer) compile, ['] abort , ( sic ) ;
@@ -101,7 +96,7 @@ decimal
 \ privatisation yoinked from pforth
 
 : (hide)  cell+ dup c@ 1 or swap c! ;
-: (unhide)  cell+ dup c@ 1 invert and swap c! ; \ todo doc
+: (unhide)  cell+ dup c@ 1 invert and swap c! ;
 : hide  parse-name ?find (hide) ;
 
 variable private0  variable private$
@@ -139,7 +134,6 @@ decimal
 : mmap  9 syscall6 ;
 : munmap  11 syscall2 ;
 
-\ todo doc
 : allocate ( u -- a e )  >r 0 -1 ( offset fd , unused here )
 	MAP_PRIVATE MAP_ANONYMOUS or ( flags )
 	PROT_READ PROT_WRITE or ( prot )
@@ -166,7 +160,6 @@ variable hld
 
 \ NONAME {{{
 \ will maybe(?) be modified later in the vocabulary section.
-\ todo doc
 false value nonaming
 
 : :noname  here  true to nonaming  postpone ] ;
-- 
cgit v1.2.3