aboutsummaryrefslogtreecommitdiff
path: root/custom/titlecase.el
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-06-28 04:00:48 -0400
committerCraig Jennings <c@cjennings.net>2026-06-28 04:00:48 -0400
commitc74396ff79d527fcc61b894f4434725a07c5a2e9 (patch)
treea3cb604850fcf3b98ad8f0955536bfbd8d8385ce /custom/titlecase.el
parent0ee61aba411e2abeee676ca802206cfc1676e04f (diff)
downloaddotemacs-c74396ff79d527fcc61b894f4434725a07c5a2e9.tar.gz
dotemacs-c74396ff79d527fcc61b894f4434725a07c5a2e9.zip
docs: normalize generated-file headers and prune obvious comments
The theme-studio and browser-choice generators now stamp their output with a header that names the authoritative source and says to regenerate rather than hand-edit. I regenerated both files to match. I also deleted six obvious "describe the next form" comments, replaced two stale placeholders in titlecase.el and an incomplete FIXME in org-checklist.el with real rationale, and condensed early-init's header and Commentary.
Diffstat (limited to 'custom/titlecase.el')
-rw-r--r--custom/titlecase.el15
1 files changed, 4 insertions, 11 deletions
diff --git a/custom/titlecase.el b/custom/titlecase.el
index 439478220..319befefd 100644
--- a/custom/titlecase.el
+++ b/custom/titlecase.el
@@ -175,7 +175,8 @@ for docs on BEGIN, END and STYLE."
titlecase-skip-words-regexps
"\\|")))
(goto-char (match-end 0))
- ;; TODO: Document what this does (it's late)
+ ;; If the skip regexp consumed the final word, exit before the main loop tries
+ ;; to advance past END.
(when (>= (point) end)
(throw :done 'skipped)))
;; Phrasal verbs!
@@ -210,16 +211,8 @@ for docs on BEGIN, END and STYLE."
((and (memq style titlecase-styles-capitalize-non-short-words)
(> (length this-word) titlecase-short-word-length))
(capitalize-word 1))
- ;; Sentence style just capitalizes the first word. Since we can't be
- ;; sure how the user has already capitalized anything, we just skip
- ;; the current word. HOWEVER, there are times when downcasing the
- ;; rest of the sentence is warranted. --- NOTE 2022-05-09: Now I'm
- ;; thinking about it, does `sentence' style need to do anything
- ;; whatsoever? Maybe I just need to include a test toward the top of
- ;; the enclosing function to make `titlecase-default-case-function'
- ;; be `downcase-word' if `titlecase-downcase-sentences' is true... or
- ;; something of that nature. I might be over-engineering this, is
- ;; what I'm saying. Curious, isn't it?
+ ;; Sentence style either leaves later words unchanged or downcases them,
+ ;; depending on titlecase-downcase-sentences.
((eq style 'sentence)
(funcall (if titlecase-downcase-sentences
#'downcase-word