From 6226db2ceb1185c435387bcbd8ee3ebf92b0567b Mon Sep 17 00:00:00 2001
From: Sage Gerard <[email]>
Date: Sat, 10 Aug 2019 20:04:12 -0400
Subject: [PATCH] Expose deleted-signal with docs correction
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The docs say that `(λ (x) null)` is the default `replace-proc` for `splitf-txexpr`.
This disagrees with the code, which uses `deleted-signal`. Since there
is a use case for conditionally removing elements, `(provide
deleted-signal)` and correct the docs.
---
 txexpr/base.rkt                 |  1 +
 txexpr/scribblings/txexpr.scrbl | 10 ++++++++--
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/txexpr/base.rkt b/txexpr/base.rkt
index cd1eced..32bd9e8 100644
--- a/txexpr/base.rkt
+++ b/txexpr/base.rkt
@@ -6,6 +6,7 @@
          (for-syntax racket/base syntax/parse))
 (provide cdata? cdata valid-char? xexpr->string xexpr?) ; from xml
 (provide empty) ; from racket/list
+(provide deleted-signal)
 
 ;; Section 2.2 of XML 1.1
 ;; (XML 1.0 is slightly different and more restrictive)
diff --git a/txexpr/scribblings/txexpr.scrbl b/txexpr/scribblings/txexpr.scrbl
index 17e0f74..f02cf33 100644
--- a/txexpr/scribblings/txexpr.scrbl
+++ b/txexpr/scribblings/txexpr.scrbl
@@ -469,12 +469,18 @@ In practice, most @racket[_txexpr-element]s are strings. But it's unwise to pass
 ]
 
 
+@deftogether[(
+
+@defthing[deleted-signal symbol?]
+
 @defproc[
 (splitf-txexpr
 [tx txexpr?]
 [pred procedure?]
-[replace-proc procedure? (λ (x) null)])
+[replace-proc procedure? (λ (x) deleted-signal)])
 (values txexpr? (listof txexpr-element?))]
+
+)]
 Recursively descend through @racket[_txexpr] and extract all elements that match @racket[_pred]. Returns two values: a @racket[_txexpr] with the matching elements removed, and the list of matching elements. Sort of esoteric, but I've needed it more than once, so here it is.
 
 @examples[#:eval my-eval
@@ -483,7 +489,7 @@ Recursively descend through @racket[_txexpr] and extract all elements that match
 (splitf-txexpr tx is-meta?)
 ]
 
-Ordinarily, the result of the split operation is to remove the elements that match @racket[_pred]. But you can change this behavior with the optional @racket[_replace-proc] argument.
+Ordinarily, the result of the split operation is to remove the elements that match @racket[_pred]. This happens only when returning @racket[_deleted-signal]. You can change this behavior with the optional @racket[_replace-proc] argument.
 
 @examples[#:eval my-eval
 (define tx '(div "Wonderful day" (meta "weather" "good") "for a walk"))