Rename org-gtd-review.el to org-gtd-reflect.el

This renaming aligns it with the name for step 4 of the GTD
methodology.  All commands renamed accordingly.

Resolves: #164

README.org

@@ -60,8 +60,8 @@ Functions:
 *** GTD Step 6/6 : Review
 Functions:
 - ~org-gtd-oops~ :: Show all the missed appointments. Oops!
-- ~org-gtd-review-area-of-focus~ :: Show an agenda view designed for one of your areas of focus.
-- ~org-gtd-review-stuck-*~ :: The =*= here is any of the action types; you can find any of the ones that have fallen through the cracks.
+- ~org-gtd-reflect-area-of-focus~ :: Show an agenda view designed for one of your areas of focus.
+- ~org-gtd-reflect-stuck-*~ :: The =*= here is any of the action types; you can find any of the ones that have fallen through the cracks.
 
 
 * Directory tree

changes-for-3.0.org

@@ -12,7 +12,7 @@ There's been a lot of issues during beta testing with proper installation of org
 ** DONE org-gtd-agenda-delegate is now org-gtd-delegate-agenda-item
 ** DONE org-gtd-cancel-project is now org-gtd-project-cancel
 ** DONE org-gtd-agenda-cancel-project is now org-gtd-project-cancel-from-agenda
-** DONE org-gtd-show-stuck-projects is now org-gtd-review-stuck-projects
+** DONE org-gtd-show-stuck-projects is now org-gtd-reflect-stuck-projects
 ** DONE org-gtd-agenda-custom-commands is gone
 Create your own functions and use ~with-org-gtd-context~ instead.
 See ~org-gtd-engage~ for an example.

doc/org-gtd.org

@@ -238,7 +238,7 @@ The nomenclature changes here because of an effort to, over time, define a bette
 Same reason as above.
 ***** ~org-gtd-agenda-cancel-project~ is now ~org-gtd-project-cancel-from-agenda~
 Same reason as above.
-***** ~org-gtd-show-stuck-projects~ is now ~org-gtd-review-stuck-projects~
+***** ~org-gtd-show-stuck-projects~ is now ~org-gtd-reflect-stuck-projects~
 Same reason as above.
 **** That's it!
 Go check out [[#new-in-3.0][What's new in 3.0]] as well as [[#configuring][Configuring]].
@@ -524,7 +524,7 @@ If you are a Doom Emacs user, then your configuration may look something like th
            :desc "Engage"         "e"  #'org-gtd-engage
            :desc "Process inbox"  "p"  #'org-gtd-process-inbox
            :desc "Show all next"  "n"  #'org-gtd-show-all-next
-           :desc "Stuck projects" "s"  #'org-gtd-review-stuck-projects))
+           :desc "Stuck projects" "s"  #'org-gtd-reflect-stuck-projects))
     (map! :map org-gtd-clarify-map
           :desc "Organize this item" "C-c c" #'org-gtd-organize))
 #+END_SRC
@@ -704,7 +704,7 @@ Horizon 2 is now handled by a variable and a hook you can add to ~org-gtd-organi
 - ~org-gtd-areas-of-focus~ is a list of strings, each representing one of your areas of focus.
 - ~org-gtd-set-area-of-focus~ is the hook you would add, e.g. ~(setq org-gtd-organize-hooks '(org-gtd-set-area-of-focus))~, it ensures each item you clarify will need to be part of a horizon.
 
-You can then use the function ~org-gtd-review-area-of-focus~ to generate an agenda view to review a specific area of focus.
+You can then use the function ~org-gtd-reflect-area-of-focus~ to generate an agenda view to review a specific area of focus.
 
 In order to add areas of focus to pre-existing items in your system, without going through the clarifying flow, we provide two functions:
 - ~org-gtd-area-of-focus-set-on-item-at-point~, when you are on a org heading
@@ -790,12 +790,12 @@ For instance, one way this could work:
 ** Finding lost tasks
 Sometimes things break. The following functions will help you find these items:
 
-- ~org-gtd-review-stuck-calendar-items~
-- ~org-gtd-review-stuck-incubated-items~
-- ~org-gtd-review-stuck-habit-items~
-- ~org-gtd-review-stuck-delegated-items~
-- ~org-gtd-review-stuck-single-action-items~
-- ~org-gtd-review-stuck-projects~
+- ~org-gtd-reflect-stuck-calendar-items~
+- ~org-gtd-reflect-stuck-incubated-items~
+- ~org-gtd-reflect-stuck-habit-items~
+- ~org-gtd-reflect-stuck-delegated-items~
+- ~org-gtd-reflect-stuck-single-action-items~
+- ~org-gtd-reflect-stuck-projects~
 
 ** Projects without a NEXT item
 

doc/org-gtd.texi

@@ -497,7 +497,7 @@ Same reason as above.
 Same reason as above.
 
 @item
-@anchor{@code{org-gtd-show-stuck-projects} is now @code{org-gtd-review-stuck-projects}}@code{org-gtd-show-stuck-projects} is now @code{org-gtd-review-stuck-projects}
+@anchor{@code{org-gtd-show-stuck-projects} is now @code{org-gtd-reflect-stuck-projects}}@code{org-gtd-show-stuck-projects} is now @code{org-gtd-reflect-stuck-projects}
 
 
 Same reason as above.
@@ -907,7 +907,7 @@ If you are a Doom Emacs user, then your configuration may look something like th
          :desc "Engage"         "e"  #'org-gtd-engage
          :desc "Process inbox"  "p"  #'org-gtd-process-inbox
          :desc "Show all next"  "n"  #'org-gtd-show-all-next
-         :desc "Stuck projects" "s"  #'org-gtd-review-stuck-projects))
+         :desc "Stuck projects" "s"  #'org-gtd-reflect-stuck-projects))
   (map! :map org-gtd-clarify-map
         :desc "Organize this item" "C-c c" #'org-gtd-organize))
 @end lisp
@@ -1190,7 +1190,7 @@ Horizon 2 is now handled by a variable and a hook you can add to @code{org-gtd-o
 @code{org-gtd-set-area-of-focus} is the hook you would add, e.g. @code{(setq org-gtd-organize-hooks '(org-gtd-set-area-of-focus))}, it ensures each item you clarify will need to be part of a horizon.
 @end itemize
 
-You can then use the function @code{org-gtd-review-area-of-focus} to generate an agenda view to review a specific area of focus.
+You can then use the function @code{org-gtd-reflect-area-of-focus} to generate an agenda view to review a specific area of focus.
 
 In order to add areas of focus to pre-existing items in your system, without going through the clarifying flow, we provide two functions:
 @itemize
@@ -1315,17 +1315,17 @@ Sometimes things break. The following functions will help you find these items:
 
 @itemize
 @item
-@code{org-gtd-review-stuck-calendar-items}
+@code{org-gtd-reflect-stuck-calendar-items}
 @item
-@code{org-gtd-review-stuck-incubated-items}
+@code{org-gtd-reflect-stuck-incubated-items}
 @item
-@code{org-gtd-review-stuck-habit-items}
+@code{org-gtd-reflect-stuck-habit-items}
 @item
-@code{org-gtd-review-stuck-delegated-items}
+@code{org-gtd-reflect-stuck-delegated-items}
 @item
-@code{org-gtd-review-stuck-single-action-items}
+@code{org-gtd-reflect-stuck-single-action-items}
 @item
-@code{org-gtd-review-stuck-projects}
+@code{org-gtd-reflect-stuck-projects}
 @end itemize
 
 @node Projects without a NEXT item

org-gtd-autoloads.el

@@ -300,11 +300,11 @@ TYPE is the org-gtd action type.  BODY is the rest of the code.
 
 ;;;***
 
-;;;### (autoloads nil "org-gtd-review" "org-gtd-review.el" (0 0 0
-;;;;;;  0))
-;;; Generated autoloads from org-gtd-review.el
+;;;### (autoloads nil "org-gtd-reflect" "org-gtd-reflect.el" (25709
+;;;;;;  52734 332852 530000))
+;;; Generated autoloads from org-gtd-reflect.el
 
-(autoload 'org-gtd-review-area-of-focus "org-gtd-review" "\
+(autoload 'org-gtd-reflect-area-of-focus "org-gtd-reflect" "\
 Generate an overview agenda for a given area of focus.
 
 You can pass an optional AREA (must be a member of `org-gtd-areas-of-focus') to
@@ -314,10 +314,24 @@ mostly of value for testing purposes.
 
 \(fn &optional AREA START-DATE)" t nil)
 
-(autoload 'org-gtd-review-stuck-projects "org-gtd-review" "\
+(defalias 'org-gtd-review-area-of-focus 'org-gtd-reflect-area-of-focus)
+
+(defalias 'org-gtd-review-stuck-calendar-items 'org-gtd-reflect-stuck-calendar-items)
+
+(defalias 'org-gtd-review-stuck-delegated-items 'org-gtd-reflect-stuck-delegated-items)
+
+(defalias 'org-gtd-review-stuck-habit-items 'org-gtd-reflect-stuck-habit-items)
+
+(defalias 'org-gtd-review-stuck-incubated-items 'org-gtd-reflect-stuck-incubated-items)
+
+(autoload 'org-gtd-reflect-stuck-projects "org-gtd-reflect" "\
 Show all projects that do not have a next action." t nil)
 
-(register-definition-prefixes "org-gtd-review" '("org-gtd-review-stuck-"))
+(defalias 'org-gtd-review-stuck-projects 'org-gtd-reflect-stuck-projects)
+
+(defalias 'org-gtd-review-stuck-single-action-items 'org-gtd-reflect-stuck-single-action-items)
+
+(if (fboundp 'register-definition-prefixes) (register-definition-prefixes "org-gtd-reflect" '("org-gtd-reflect-stuck-")))
 
 ;;;***
 

org-gtd-review.el → org-gtd-reflect.el

@@ -1,4 +1,4 @@
-;;; org-gtd-review.el --- GTD review logic for org-gtd -*- lexical-binding: t; coding: utf-8 -*-
+;;; org-gtd-reflect.el --- Reflect on system contents -*- lexical-binding: t; coding: utf-8 -*-
 ;;
 ;; Copyright © 2019-2023 Aldric Giacomoni
 
@@ -26,6 +26,7 @@
 ;;; Code:
 
 ;;;; Requirements
+
 (require 'org)
 
 (require 'org-gtd-core)
@@ -37,7 +38,7 @@
 ;;;; Commands
 
 ;;;###autoload
-(defun org-gtd-review-area-of-focus (&optional area start-date)
+(defun org-gtd-reflect-area-of-focus (&optional area start-date)
   "Generate an overview agenda for a given area of focus.
 
 You can pass an optional AREA (must be a member of `org-gtd-areas-of-focus') to
@@ -91,7 +92,11 @@ mostly of value for testing purposes."
           (org-agenda nil "a")
           (goto-char (point-min))))))
 
-(defun org-gtd-review-stuck-calendar-items ()
+;;;###autoload
+(defalias 'org-gtd-review-area-of-focus 'org-gtd-reflect-area-of-focus)
+(make-obsolete 'org-gtd-review-area-of-focus "use `org-gtd-reflect-area-of-focus' instead." "2023-05-24")
+
+(defun org-gtd-reflect-stuck-calendar-items ()
   "Agenda view with all invalid Calendar actions."
   (interactive)
   (with-org-gtd-context
@@ -104,7 +109,11 @@ mostly of value for testing purposes."
                         (org-agenda-skip-additional-timestamps-same-entry t))))))))
         (org-agenda nil "g"))))
 
-(defun org-gtd-review-stuck-delegated-items ()
+;;;###autoload
+(defalias 'org-gtd-review-stuck-calendar-items 'org-gtd-reflect-stuck-calendar-items)
+(make-obsolete 'org-gtd-review-stuck-calendar-items "use `org-gtd-reflect-stuck-calendar-items' instead." "2023-05-24")
+
+(defun org-gtd-reflect-stuck-delegated-items ()
   "Agenda view with all invalid Calendar actions."
   (interactive)
   (with-org-gtd-context
@@ -118,7 +127,11 @@ mostly of value for testing purposes."
                         (org-agenda-skip-additional-timestamps-same-entry t))))))))
         (org-agenda nil "g"))))
 
-(defun org-gtd-review-stuck-habit-items ()
+;;;###autoload
+(defalias 'org-gtd-review-stuck-delegated-items 'org-gtd-reflect-stuck-delegated-items)
+(make-obsolete 'org-gtd-review-stuck-delegated-items "use `org-gtd-reflect-stuck-delegated-items' instead." "2023-05-24")
+
+(defun org-gtd-reflect-stuck-habit-items ()
   "Agenda view with all invalid Calendar actions."
   (interactive)
   (with-org-gtd-context
@@ -130,7 +143,11 @@ mostly of value for testing purposes."
                         (org-agenda-skip-additional-timestamps-same-entry t))))))))
         (org-agenda nil "g"))))
 
-(defun org-gtd-review-stuck-incubated-items ()
+;;;###autoload
+(defalias 'org-gtd-review-stuck-habit-items 'org-gtd-reflect-stuck-habit-items)
+(make-obsolete 'org-gtd-review-stuck-habit-items "use `org-gtd-reflect-stuck-habit-items' instead." "2023-05-24")
+
+(defun org-gtd-reflect-stuck-incubated-items ()
   "Agenda view with all invalid Calendar actions."
   (interactive)
   (with-org-gtd-context
@@ -143,13 +160,21 @@ mostly of value for testing purposes."
         (org-agenda nil "g"))))
 
 ;;;###autoload
-(defun org-gtd-review-stuck-projects ()
+(defalias 'org-gtd-review-stuck-incubated-items 'org-gtd-reflect-stuck-incubated-items)
+(make-obsolete 'org-gtd-review-stuck-incubated-items "use `org-gtd-reflect-stuck-incubated-items' instead." "2023-05-24")
+
+;;;###autoload
+(defun org-gtd-reflect-stuck-projects ()
   "Show all projects that do not have a next action."
   (interactive)
   (with-org-gtd-context
       (org-agenda-list-stuck-projects)))
 
-(defun org-gtd-review-stuck-single-action-items ()
+;;;###autoload
+(defalias 'org-gtd-review-stuck-projects 'org-gtd-reflect-stuck-projects)
+(make-obsolete 'org-gtd-review-stuck-projects "use `org-gtd-reflect-stuck-projects' instead." "2023-05-24")
+
+(defun org-gtd-reflect-stuck-single-action-items ()
   "Agenda view with all invalid Calendar actions."
   (interactive)
   (with-org-gtd-context
@@ -161,6 +186,10 @@ mostly of value for testing purposes."
                         (org-agenda-skip-additional-timestamps-same-entry t))))))))
         (org-agenda nil "g"))))
 
+;;;###autoload
+(defalias 'org-gtd-review-stuck-single-action-items 'org-gtd-reflect-stuck-single-action-items)
+(make-obsolete 'org-gtd-review-stuck-single-action-items "use `org-gtd-reflect-stuck-single-action-items' instead." "2023-05-24")
+
 ;;;; Functions
 
 ;;;;; Private
@@ -172,6 +201,6 @@ mostly of value for testing purposes."
 
 ;;;; Footer
 
-(provide 'org-gtd-review)
+(provide 'org-gtd-reflect)
 
-;;; org-gtd-review.el ends here
+;;; org-gtd-reflect.el ends here

org-gtd.el

@@ -66,7 +66,7 @@
 (require 'org-gtd-organize)
 (require 'org-gtd-process)
 (require 'org-gtd-mode)
-(require 'org-gtd-review)
+(require 'org-gtd-reflect)
 (require 'org-gtd-oops)
 (require 'org-gtd-upgrades)