branch: externals/denote-sequence
commit 01fa8fba3c5363c7f1dfe7dcc6331f8ae34339b1
Author: Protesilaos Stavrou <[email protected]>
Commit: Protesilaos Stavrou <[email protected]>
Call it "sequence scheme" not "sequencing scheme"
---
README.org | 8 ++++----
denote-sequence.el | 14 +++++++-------
2 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/README.org b/README.org
index 5bd0805699..67c5033aaa 100644
--- a/README.org
+++ b/README.org
@@ -68,7 +68,7 @@ modify this GNU manual.”
:END:
The ~denote-sequence~ package provides an optional extension to
-~denote~ for naming files with a sequencing scheme. The idea is to
+~denote~ for naming files with a sequence scheme. The idea is to
establish hiearchical relationships between files, such that the
contents of one logically follow or complement those of another.
@@ -101,7 +101,7 @@ The =denote-sequence.el= optional extension is not
necessary for such
a workflow. Users can always define whatever =SIGNATURE= they want
manually. The purpose of this extension is to streamline this work.
-** Select a sequencing scheme for ~denote-sequence-scheme~
+** Select a sequence scheme for ~denote-sequence-scheme~
:PROPERTIES:
:CUSTOM_ID: h:select-a-sequencing-scheme-for-denote-sequence-scheme
:END:
@@ -168,7 +168,7 @@ optional prompt is part of {{{development-version}}}. ]
[ In the interest of simplicity, here we provide examples using the
=numeric= value of ~denote-sequence-scheme~, though the =alphanumeric=
- will work as well
([[#h:select-a-sequencing-scheme-for-denote-sequence-scheme][Select a
sequencing scheme for ~denote-sequence-scheme~]]). ]
+ will work as well
([[#h:select-a-sequencing-scheme-for-denote-sequence-scheme][Select a sequence
scheme for ~denote-sequence-scheme~]]). ]
A new sequence note can be of the type =parent=, =child=, and
=sibling=. For the convenience of the user, we provide commands to
@@ -272,7 +272,7 @@ contain a sequence as their file name =SIGNATURE=
([[#h:write-sequence-notes-or-
[ In the interest of simplicity, here we provide examples using the
=numeric= value of ~denote-sequence-scheme~, though the =alphanumeric=
- will work as well
([[#h:select-a-sequencing-scheme-for-denote-sequence-scheme][Select a
sequencing scheme for ~denote-sequence-scheme~]]). ]
+ will work as well
([[#h:select-a-sequencing-scheme-for-denote-sequence-scheme][Select a sequence
scheme for ~denote-sequence-scheme~]]). ]
#+findex: denote-sequence-dired
The command ~denote-sequence-dired~ produces a bespoke and fully
diff --git a/denote-sequence.el b/denote-sequence.el
index 7144e9a7d6..532d7e61da 100644
--- a/denote-sequence.el
+++ b/denote-sequence.el
@@ -69,7 +69,7 @@
;; TODO 2026-03-24: The `alphanumeric-delimited' is not supporting partial
sequences.
;; This will probably be a problem for `denote-sequence-convert'.
(defcustom denote-sequence-scheme 'numeric
- "Sequencing scheme to establish file hierarchies.
+ "Sequence scheme to establish file hierarchies.
The value is a symbol among `numeric', `alphanumeric', and
`alphanumeric-delimited'. Users can change the applicable scheme for
one file or those marked in Dired by calling the command
@@ -256,16 +256,16 @@ Also see `denote-sequence-numeric-p' and
`denote-sequence-alphanumeric-p'."
(denote-sequence--alphanumeric-partial-p string)))
(defun denote-sequence-and-scheme-p (sequence &optional partial)
- "Return the sequencing scheme of SEQUENCE, per `denote-sequence-scheme'.
+ "Return the sequence scheme of SEQUENCE, per `denote-sequence-scheme'.
Return a cons cell of the form (sequence . scheme), where the `car' is
-SEQUENCE and the `cdr' is its sequencing scheme as a symbol among those
+SEQUENCE and the `cdr' is its sequence scheme as a symbol among those
mentioned in `denote-sequence-scheme'.
With optional PARTIAL as a non-nil value, assume SEQUENCE to be a string
that only represents part of a sequence, which itself consists entirely
of numbers or letters.
-Produce an error if the sequencing scheme cannot be established."
+Produce an error if the sequence scheme cannot be established."
(cond
((and (not partial) (string-match-p "\\`[0-9]+\\'" sequence))
(cons sequence denote-sequence-scheme))
@@ -285,9 +285,9 @@ Produce an error if the sequencing scheme cannot be
established."
(t (error "The sequence `%s' does not pass `denote-sequence-and-scheme-p'"
sequence))))
;; FIXME 2026-03-24: This is technically incorrect because it assumes
-;; homogeneity of sequencing schemes. But we never enforce as much.
+;; homogeneity of sequence schemes. But we never enforce as much.
(defun denote-sequence--scheme-of-strings (strings)
- "Return the sequencing scheme of STRINGS, per `denote-sequence-scheme'."
+ "Return the sequence scheme of STRINGS, per `denote-sequence-scheme'."
(cond
((seq-every-p #'denote-sequence-numeric-p strings)
'numeric)
@@ -420,7 +420,7 @@ If SEQUENCE conforms with `denote-sequence-alphanumeric-p',
return it as-is."
(denote-sequence-join converted-parts target-scheme))))
(defun denote-sequence-make-conversion (string target-scheme &optional
string-is-partial-sequence)
- "Convert STRING to the given sequencing TARGET-SCHEME.
+ "Convert STRING to the given sequence TARGET-SCHEME.
With optional STRING-IS-PARTIAL-SEQUENCE interpret STRING accordingly."
(unless (memq target-scheme denote-sequence-schemes)
(error "The TARGET-SCHEME can only be one among the
`denote-sequence-schemes'"))
