aboutsummaryrefslogtreecommitdiff
path: root/chime-org-contacts.el
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-05-05 09:50:57 -0500
committerCraig Jennings <c@cjennings.net>2026-05-05 09:50:57 -0500
commit18bad1aa33e25873b7f30b9d42adde071a63bad9 (patch)
tree3f4d4761680b58d7b23f26f1b9c9c8d18a0ece87 /chime-org-contacts.el
parent1f57189ffbe4f039ea213918c97d0a9496b4db7b (diff)
downloadchime-18bad1aa33e25873b7f30b9d42adde071a63bad9.tar.gz
chime-18bad1aa33e25873b7f30b9d42adde071a63bad9.zip
refactor: clear the rest of the lint backlog and make `make lint' actually work
Took the package-lint commit's foundation and finished the job. Three groups of changes: 1. **checkdoc** is now clean across all three package files. I worked through every warning: 13 missing-double-space-after-period fixes, 4 message-capitalization fixes, 1 trailing-period-on-error fix, 6 Lisp-symbol-should-be-quoted fixes, and one rephrase from "starts" to the imperative "Log the start of an async check". One `chime-debug.el' docstring also exceeded 80 columns and got split into two lines. 2. **`make lint'** ran elisp-lint but had been silently broken. The shell glob `test-*.el' wasn't expanding (CWD ended up at project root, not tests/), and the noisy validators flagged everything. I rewrote the target to lint package files explicitly via absolute paths, preload chime.el so the byte-compiler sees cross-file symbols when checking chime-debug.el, and disable the validators that conflict with project style or duplicate other lint steps: - `--no-checkdoc' (covered by `eask lint checkdoc') - `--no-package-lint' (covered by `eask lint package'; running it on auxiliary files re-flags them as standalone packages) - `--no-indent-character' (project uses spaces per `.claude/rules/elisp.md'; the validator defaults to tabs) - `--no-fill-column' (project allows up to 80; validator defaults to 70) - `--no-indent' (false-positives on dash threading macros `->'/`->>') The validators-disabled list is documented in the recipe header. 3. **Generated autoload files** (`chime-autoloads.el', `tests/tests-autoloads.el') are now gitignored. `tests/tests-autoloads.el' was tracked from an earlier commit; I removed it from the index. Eask regenerates these on every `eask compile' / `eask install-deps' run, so they don't belong in the tree. Verified: `make compile' clean (with byte-compile-error-on-warn t), `make test-all' green at 677 tests, `eask lint package' clean, `eask lint checkdoc' clean, `make lint' clean. Full lint backlog is now zero across all three checks.
Diffstat (limited to 'chime-org-contacts.el')
-rw-r--r--chime-org-contacts.el16
1 files changed, 8 insertions, 8 deletions
diff --git a/chime-org-contacts.el b/chime-org-contacts.el
index 6c9e590..ef3aede 100644
--- a/chime-org-contacts.el
+++ b/chime-org-contacts.el
@@ -27,7 +27,7 @@
;; Optional org-contacts integration for chime.el
;;
;; This module provides an org-capture template that automatically inserts
-;; birthday timestamps when creating new contacts. This complements the
+;; birthday timestamps when creating new contacts. This complements the
;; chime conversion script (convert-org-contacts-birthdays.el) which handles
;; existing contacts.
;;
@@ -39,7 +39,7 @@
;; - Automatically insert yearly repeating timestamps for birthdays
;; - Enable birthdays to appear in org-agenda without org-contacts loaded
;;
-;; The integration is disabled by default. Set `chime-org-contacts-file'
+;; The integration is disabled by default. Set `chime-org-contacts-file'
;; to enable it.
;;; Code:
@@ -59,9 +59,9 @@
When nil, org-contacts capture integration is disabled.
-When set to a file path, chime will add an org-capture template
+When set to a file path, chime will add an `org-capture' template
that automatically inserts birthday timestamps for new contacts,
-enabling them to appear in org-agenda without requiring org-contacts
+enabling them to appear in `org-agenda' without requiring org-contacts
to be loaded in the async subprocess.
Example:
@@ -73,7 +73,7 @@ Example:
(defcustom chime-org-contacts-capture-key "C"
"Key binding for chime org-contacts capture template.
-This is the key you press after invoking org-capture (C-c c by default).
+This is the key you press after invoking `org-capture' (C-c c by default).
Change this if you already have a capture template using \"C\"."
:type 'string
:group 'chime-org-contacts)
@@ -94,8 +94,8 @@ New contacts will be filed under this heading in `chime-org-contacts-file'."
(defun chime-org-contacts--finalize-birthday-timestamp ()
"Add yearly repeating timestamp after properties drawer if BIRTHDAY is set.
-This function is called during org-capture finalization to automatically
-insert a plain timestamp for birthdays, enabling them to appear in org-agenda
+This function is called during `org-capture' finalization to automatically
+insert a plain timestamp for birthdays, enabling them to appear in `org-agenda'
without requiring org-contacts to be loaded in the async subprocess.
Delegates to `chime--insert-birthday-timestamp-after-drawer' for the
@@ -110,7 +110,7 @@ actual parsing, formatting, and insertion."
(user-error nil)))))))
(defun chime-org-contacts--setup-capture-template ()
- "Add org-capture template for contacts with birthday timestamps.
+ "Add `org-capture' template for contacts with birthday timestamps.
This template will only be added if:
1. `chime-org-contacts-file' is set