remove the useless "TODO: documentation"

see #11
amtoine · Sep 1, 2023 · ef4aa3e · ef4aa3e
1 parent 469f20d
commit ef4aa3e
Show file tree

Hide file tree

Showing 4 changed files with 0 additions and 10 deletions.
diff --git a/src/app.rs b/src/app.rs
@@ -15,7 +15,6 @@ pub enum Mode {
     Insert,
     /// the PEEKING mode lets the user *peek* data out of the application, to be reused later
     Peeking,
-    /// TODO: documentation
     Bottom,
 }
 
@@ -86,12 +85,10 @@ impl App {
         app
     }
 
-    /// TODO: documentation
     pub fn is_at_bottom(&self) -> bool {
         matches!(self.mode, Mode::Bottom)
     }
 
-    /// TODO: documentation
     pub fn hit_bottom(&mut self) {
         self.mode = Mode::Bottom;
     }

diff --git a/src/edit.rs b/src/edit.rs
@@ -92,7 +92,6 @@ impl Editor {
         self.move_cursor_right();
     }
 
-    /// TODO: documentation
     fn delete_char(&mut self, offset: i32) {
         let position = (self.position() as i32 + offset) as usize;
 
@@ -118,7 +117,6 @@ impl Editor {
         self.delete_char(0);
     }
 
-    /// TODO: documentation
     pub(super) fn handle_key(&mut self, key: &KeyCode) -> Option<Option<Value>> {
         match key {
             KeyCode::Left => self.move_cursor_left(),

diff --git a/src/nu/strings.rs b/src/nu/strings.rs
@@ -1,4 +1,3 @@
-/// TODO: documentation
 #[derive(Debug, PartialEq)]
 pub(crate) enum SpecialString {
     Url,
@@ -15,7 +14,6 @@ impl std::fmt::Display for SpecialString {
     }
 }
 
-/// TODO: documentation
 impl SpecialString {
     pub(crate) fn parse(input: &str) -> Option<Self> {
         if let Ok(url) = url::Url::parse(input) {

diff --git a/src/nu/value.rs b/src/nu/value.rs
@@ -1,10 +1,8 @@
-//! TODO: documentation
 use nu_protocol::{
     ast::{CellPath, PathMember},
     Record, Span, Value,
 };
 
-/// TODO: documentation
 pub(crate) fn mutate_value_cell(value: &Value, cell_path: &CellPath, cell: &Value) -> Value {
     if cell_path.members.is_empty() {
         return cell.clone();
@@ -59,7 +57,6 @@ pub(crate) fn mutate_value_cell(value: &Value, cell_path: &CellPath, cell: &Valu
     }
 }
 
-/// TODO: documentation
 pub(crate) fn is_table(value: &Value) -> bool {
     match value {
         Value::List { vals, .. } => {