diff options
| author | Craig Jennings <c@cjennings.net> | 2026-07-21 06:42:54 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2026-07-21 06:42:54 -0500 |
| commit | 24f8c5aac8873837824ca6d61e566e3e24c96ad5 (patch) | |
| tree | 40336f31bf714ab8fc39596ce5324dda035467fc /org-drill.el | |
| parent | e201ba696ed27e407d934321a5f4c5874ea4fee5 (diff) | |
| download | org-drill-24f8c5aac8873837824ca6d61e566e3e24c96ad5.tar.gz org-drill-24f8c5aac8873837824ca6d61e566e3e24c96ad5.zip | |
docs: reflow spec tables, fix docstrings, add code-scan findings report
The two design-spec tables now follow the org table standard. I shortened three docstring first lines past the 80-column byte-compile warning and corrected the two visible-cloze face docstrings, which carried the hidden-cloze wording verbatim. The new findings report (docs/design/2026-07-21-code-scan-findings.org) records a full scan of org-drill.el: 22 graded bugs and 5 refactor groups with file:line evidence and fix directions. The gitignore gains the task-archive path so the archive stays untracked like the todo file.
Diffstat (limited to 'org-drill.el')
| -rw-r--r-- | org-drill.el | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/org-drill.el b/org-drill.el index 343009d..11f161e 100644 --- a/org-drill.el +++ b/org-drill.el @@ -202,12 +202,12 @@ Possible values: (defface org-drill-visible-cloze-face '((t (:foreground "darkseagreen"))) - "The face used to hide the contents of cloze phrases." + "The face used for visible cloze text." :group 'org-drill-display) (defface org-drill-visible-cloze-hint-face '((t (:foreground "dark slate blue"))) - "The face used to hide the contents of cloze phrases." + "The face used for hints inside visible cloze text." :group 'org-drill-display) (defface org-drill-hidden-cloze-face @@ -919,7 +919,7 @@ even if answered correctly." :type 'integer) (defvar org-drill--lapse-very-overdue-entries-p nil - "If non-nil, entries more than `org-drill-lapse-threshold-days' overdue are lapsed. + "If non-nil, lapse entries `org-drill-lapse-threshold-days' overdue. This means that when the item is eventually re-tested it will be treated as \\='failed\\=' (quality 2) for rescheduling purposes, regardless of whether the test was successful.") @@ -1305,7 +1305,7 @@ Returns the parsed list or nil if invalid or unsafe." last-interval repetitions ease failures meanq total-repeats) (defun org-drill-get-item-data () - "Return an `org-drill-card-state' with the stored recall data for the item at point. + "Return an `org-drill-card-state' with the item at point's recall data. Slots: - LAST-INTERVAL is the interval in days that was used to schedule the item's @@ -1357,7 +1357,7 @@ Slots: :total-repeats 0 :meanq nil :ease nil))))) (defun org-drill-store-item-data (state) - "Store the recall data in STATE, an `org-drill-card-state', into the item at point. + "Store STATE, an `org-drill-card-state', into the item at point. STATE's LAST-INTERVAL slot holds the interval to schedule going forward (the caller passes the scheduler's next-interval there)." (org-entry-delete (point) "LEARN_DATA") |