Merge pull request #411 from djmitche/not-garbage-collection

Replace "garbage-collection" with more precise words

docs/src/taskdb.md

@@ -28,5 +28,6 @@ Operations are checked for validity as they are applied.
 ## Deletion and Expiration
 
 Deletion of a task merely changes the task's status to "deleted", leaving it in the Task database.
-Actual removal of tasks from the task database takes place as part of _expiration_, triggered by the user as part of a garbage-collection process.
-Expiration removes tasks with a `modified` property more than 180 days in the past, by creating a `Delete(uuid)` operation.
+Actual removal of tasks from the task database takes place as part of _expiration_.
+TaskChampion does not automatically expire tasks, although applications using TaskChampion, such as Taskwarrior, may do so.
+The expiration process removes tasks with a `modified` property more than 180 days in the past, by creating a `Delete(uuid)` operation.

taskchampion/src/replica.rs

@@ -27,8 +27,8 @@ use uuid::Uuid;
 ///
 /// A replica maintains a "working set" of tasks that are of current concern to the user,
 /// specifically pending tasks.  These are indexed with small, easy-to-type integers.  Newly
-/// pending tasks are automatically added to the working set, and the working set is "renumbered"
-/// during the garbage-collection process.
+/// pending tasks are automatically added to the working set, and the working set can be
+/// "renumbered" when necessary.
 pub struct Replica {
     taskdb: TaskDb,
 

taskchampion/src/storage/mod.rs

@@ -105,7 +105,7 @@ pub trait StorageTxn {
     /// working set.
     fn set_working_set_item(&mut self, index: usize, uuid: Option<Uuid>) -> Result<()>;
 
-    /// Clear all tasks from the working set in preparation for a garbage-collection operation.
+    /// Clear all tasks from the working set in preparation for a renumbering operation.
     /// Note that this is the only way items are removed from the set.
     fn clear_working_set(&mut self) -> Result<()>;