Use 'todo' instead of 'TODO' for comments in TodoMVC

So they don't look like things we need to fix...

Author: fitzgen

examples/todomvc/src/controller.rs

@@ -15,7 +15,7 @@ use std::ops::{Deref, DerefMut};
 ///
 /// One could imagine alternative controller implementations with `*Actions`
 /// trait implementations for (e.g.) testing that will assert various expected
-/// action methods are called after rendering TODO items and sending DOM events.
+/// action methods are called after rendering todo items and sending DOM events.
 #[derive(Default, Deserialize, Serialize)]
 pub struct Controller;
 

examples/todomvc/src/lib.rs

@@ -24,7 +24,7 @@ pub fn run() -> Result<(), JsValue> {
     // Set up the logging for debugging if/when things go wrong.
     init_logging();
 
-    // Grab the TODO app container.
+    // Grab the todo app container.
     let document = utils::document();
     let container = document
         .query_selector(".todoapp")?

examples/todomvc/src/router.rs

@@ -12,7 +12,7 @@ use wasm_bindgen::JsCast;
 /// Start the router.
 pub fn start(vdom: VdomWeak) {
     // Callback fired whenever the URL's hash fragment changes. Keeps the root
-    // TODOs collection's visibility in sync with the `#` fragment.
+    // todos collection's visibility in sync with the `#` fragment.
     let on_hash_change = move || {
         let new_vis = utils::hash()
             .and_then(|hash| {

examples/todomvc/src/todo.rs

@@ -1,12 +1,12 @@
-//! Type definition and `dodrio::Render` implementation for a single TODO item.
+//! Type definition and `dodrio::Render` implementation for a single todo item.
 
 use crate::keys;
 use dodrio::{bumpalo::Bump, on, Attribute, Node, Render, RootRender, VdomWeak};
 use serde::{Deserialize, Serialize};
 use std::marker::PhantomData;
 use wasm_bindgen::{prelude::*, JsCast};
 
-/// A single TODO item.
+/// A single todo item.
 #[derive(Serialize, Deserialize)]
 pub struct Todo<C> {
     id: usize,
@@ -20,24 +20,24 @@ pub struct Todo<C> {
     _controller: PhantomData<C>,
 }
 
-/// Actions on a single TODO item that can be triggered from the UI.
+/// Actions on a single todo item that can be triggered from the UI.
 pub trait TodoActions {
-    /// Toggle the completion state of the TODO item with the given id.
+    /// Toggle the completion state of the todo item with the given id.
     fn toggle_completed(root: &mut dyn RootRender, vdom: VdomWeak, id: usize);
 
-    /// Delete the TODO item with the given id.
+    /// Delete the todo item with the given id.
     fn delete(root: &mut dyn RootRender, vdom: VdomWeak, id: usize);
 
-    /// Begin editing the TODO item with the given id.
+    /// Begin editing the todo item with the given id.
     fn begin_editing(root: &mut dyn RootRender, vdom: VdomWeak, id: usize);
 
-    /// Update the edits for the TODO with the given id.
+    /// Update the edits for the todo with the given id.
     fn update_edits(root: &mut dyn RootRender, vdom: VdomWeak, id: usize, edits: String);
 
-    /// Finish editing the TODO with the given id.
+    /// Finish editing the todo with the given id.
     fn finish_edits(root: &mut dyn RootRender, vdom: VdomWeak, id: usize);
 
-    /// Cancel editing the TODO with the given id.
+    /// Cancel editing the todo with the given id.
     fn cancel_edits(root: &mut dyn RootRender, vdom: VdomWeak, id: usize);
 }
 
@@ -56,7 +56,7 @@ impl<C> Todo<C> {
         }
     }
 
-    /// Set this TODO item's id.
+    /// Set this todo item's id.
     pub fn set_id(&mut self, id: usize) {
         self.id = id;
     }
@@ -71,22 +71,22 @@ impl<C> Todo<C> {
         self.completed = to;
     }
 
-    /// Get this TODO's title.
+    /// Get this todo's title.
     pub fn title(&self) -> &str {
         &self.title
     }
 
-    /// Set this TODO item's title.
+    /// Set this todo item's title.
     pub fn set_title<S: Into<String>>(&mut self, title: S) {
         self.title = title.into();
     }
 
-    /// Set the edits for this TODO.
+    /// Set the edits for this todo.
     pub fn set_edits<S: Into<String>>(&mut self, edits: Option<S>) {
         self.edits = edits.map(Into::into);
     }
 
-    /// Take this TODO's edits, leaving `None` in their place.
+    /// Take this todo's edits, leaving `None` in their place.
     pub fn take_edits(&mut self) -> Option<String> {
         self.edits.take()
     }

examples/todomvc/src/todos.rs

@@ -1,5 +1,5 @@
 //! Type definitions and `dodrio::Render` implementation for a collection of
-//! TODO items.
+//! todo items.
 
 use crate::controller::Controller;
 use crate::todo::{Todo, TodoActions};
@@ -15,7 +15,7 @@ use std::mem;
 use wasm_bindgen::prelude::*;
 use wasm_bindgen::JsCast;
 
-/// A collection of TODOs.
+/// A collection of todos.
 #[derive(Default, Serialize, Deserialize)]
 #[serde(rename = "todos-dodrio", bound = "")]
 pub struct Todos<C = Controller> {
@@ -33,25 +33,25 @@ pub struct Todos<C = Controller> {
 
 /// Actions for `Todos` that can be triggered by UI interactions.
 pub trait TodosActions: TodoActions {
-    /// Toggle the completion state of all TODO items.
+    /// Toggle the completion state of all todo items.
     fn toggle_all(root: &mut dyn RootRender, vdom: VdomWeak);
 
-    /// Update the draft TODO item's text.
+    /// Update the draft todo item's text.
     fn update_draft(root: &mut dyn RootRender, vdom: VdomWeak, draft: String);
 
-    /// Finish the current draft TODO item and add it to the collection of
-    /// TODOs.
+    /// Finish the current draft todo item and add it to the collection of
+    /// todos.
     fn finish_draft(root: &mut dyn RootRender, vdom: VdomWeak);
 
-    /// Change the TODO item visibility filtering to the given `Visibility`.
+    /// Change the todo item visibility filtering to the given `Visibility`.
     fn change_visibility(root: &mut dyn RootRender, vdom: VdomWeak, vis: Visibility);
 
-    /// Delete all completed TODO items.
+    /// Delete all completed todo items.
     fn delete_completed(root: &mut dyn RootRender, vdom: VdomWeak);
 }
 
 impl<C> Todos<C> {
-    /// Construct a new TODOs set.
+    /// Construct a new todos set.
     ///
     /// If an existing set is available in local storage, then us that,
     /// otherwise create a new set.
@@ -62,7 +62,7 @@ impl<C> Todos<C> {
         Self::from_local_storage().unwrap_or_default()
     }
 
-    /// Deserialize a set of TODOs from local storage.
+    /// Deserialize a set of todos from local storage.
     pub fn from_local_storage() -> Option<Self> {
         utils::local_storage()
             .get("todomvc-dodrio")
@@ -71,49 +71,49 @@ impl<C> Todos<C> {
             .and_then(|json| serde_json::from_str(&json).ok())
     }
 
-    /// Serialize this set of TODOs to local storage.
+    /// Serialize this set of todos to local storage.
     pub fn save_to_local_storage(&self) {
         let serialized = serde_json::to_string(self).unwrap_throw();
         utils::local_storage()
             .set("todomvc-dodrio", &serialized)
             .unwrap_throw();
     }
 
-    /// Add a new TODO item to this collection.
+    /// Add a new todo item to this collection.
     pub fn add_todo(&mut self, todo: Todo<C>) {
         self.todos.push(todo);
     }
 
-    /// Delete the TODO with the given id.
+    /// Delete the todo with the given id.
     pub fn delete_todo(&mut self, id: usize) {
         self.todos.remove(id);
         self.fix_ids();
     }
 
-    /// Delete all completed TODO items.
+    /// Delete all completed todo items.
     pub fn delete_completed(&mut self) {
         self.todos.retain(|t| !t.is_complete());
         self.fix_ids();
     }
 
-    // Fix all TODO identifiers so that they match their index once again.
+    // Fix all todo identifiers so that they match their index once again.
     fn fix_ids(&mut self) {
         for (id, todo) in self.todos.iter_mut().enumerate() {
             todo.set_id(id);
         }
     }
 
-    /// Get a shared slice of the underlying set of TODO items.
+    /// Get a shared slice of the underlying set of todo items.
     pub fn todos(&self) -> &[Todo<C>] {
         &self.todos
     }
 
-    /// Get an exclusive slice of the underlying set of TODO items.
+    /// Get an exclusive slice of the underlying set of todo items.
     pub fn todos_mut(&mut self) -> &mut [Todo<C>] {
         &mut self.todos
     }
 
-    /// Set the draft TODO item text.
+    /// Set the draft todo item text.
     pub fn set_draft<S: Into<String>>(&mut self, draft: S) {
         self.draft = draft.into();
     }
@@ -123,12 +123,12 @@ impl<C> Todos<C> {
         mem::replace(&mut self.draft, String::new())
     }
 
-    /// Get the current visibility for these TODOs.
+    /// Get the current visibility for these todos.
     pub fn visibility(&self) -> Visibility {
         self.visibility
     }
 
-    /// Set the visibility for these TODOS.
+    /// Set the visibility for these todoS.
     pub fn set_visibility(&mut self, vis: Visibility) {
         self.visibility = vis;
     }

examples/todomvc/src/visibility.rs

@@ -3,14 +3,14 @@
 use std::fmt;
 use std::str::FromStr;
 
-/// The visibility filtering for TODO items.
+/// The visibility filtering for todo items.
 #[derive(Clone, Copy, Eq, PartialEq)]
 pub enum Visibility {
-    /// Show all TODOs.
+    /// Show all todos.
     All,
-    /// Show only active, incomplete TODOs.
+    /// Show only active, incomplete todos.
     Active,
-    /// Show only inactive, completed TODOs.
+    /// Show only inactive, completed todos.
     Completed,
 }