From 5e48997ecb4df8ce9507e6229df457d1065b19bc Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Mon, 21 Mar 2022 02:11:16 +0100
Subject: Add placeholders for code documentation reminders

---
 src/insert.rs     | 1 +
 src/lib.rs        | 1 +
 src/select.rs     | 2 ++
 src/sqlite.rs     | 1 +
 src/yaml.rs       | 1 +
 src/yaml/sql.rs   | 3 +++
 src/yaml/write.rs | 2 ++
 7 files changed, 11 insertions(+)

(limited to 'src')

diff --git a/src/insert.rs b/src/insert.rs
index d01c203..9cd5fe5 100644
--- a/src/insert.rs
+++ b/src/insert.rs
@@ -1,3 +1,4 @@
+/// TODO
 pub fn insert(
     dbconn: &mut rusqlite::Connection,
     table_name: &str,
diff --git a/src/lib.rs b/src/lib.rs
index f434ef2..1e27259 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -8,6 +8,7 @@ pub use insert::*;
 pub use select::*;
 
 
+/// TODO
 #[derive(thiserror::Error, Debug)]
 pub enum Error {
     #[error("SQL error: {0}")]
diff --git a/src/select.rs b/src/select.rs
index b00733b..b5251ff 100644
--- a/src/select.rs
+++ b/src/select.rs
@@ -1,3 +1,4 @@
+/// TODO
 pub fn select<C>(
     dbconn: &rusqlite::Connection,
     table_name: &str,
@@ -15,6 +16,7 @@ where C: AsRef<str> + PartialEq<String>
     )
 }
 
+/// TODO
 pub fn select_by_column<C>(
     dbconn: &rusqlite::Connection,
     table_name: &str,
diff --git a/src/sqlite.rs b/src/sqlite.rs
index 2185e66..dcc88de 100644
--- a/src/sqlite.rs
+++ b/src/sqlite.rs
@@ -3,6 +3,7 @@ use rusqlite;
 use std::collections::HashSet;
 
 
+/// TODO
 pub fn get_column_names(
     dbconn: &rusqlite::Connection,
     table_name: &str,
diff --git a/src/yaml.rs b/src/yaml.rs
index af71779..ed64afd 100644
--- a/src/yaml.rs
+++ b/src/yaml.rs
@@ -14,6 +14,7 @@ pub use write::*;
 
 // TODO: Separate functions to get a list of YAML hashes, and insert hashes into
 // the database.
+/// TODO
 pub fn extract(
     doc: &mut yaml::Yaml,
     tx: &rusqlite::Transaction,
diff --git a/src/yaml/sql.rs b/src/yaml/sql.rs
index ef72aae..ac60dc3 100644
--- a/src/yaml/sql.rs
+++ b/src/yaml/sql.rs
@@ -3,9 +3,11 @@ use yaml_rust::yaml;
 use std::borrow::Cow;
 
 
+/// TODO
 #[derive(Debug)]
 pub(crate) struct Yaml<'a>(pub Cow<'a, yaml::Yaml>);
 
+// TODO: Delete
 // impl<'a, Y> From<Y> for Yaml<'a>
 // where Y: Into<yaml_rust::Yaml>
 // {
@@ -17,6 +19,7 @@ pub(crate) struct Yaml<'a>(pub Cow<'a, yaml::Yaml>);
 // impl From<
 
 impl<'a> Yaml<'a> {
+    /// TODO
     pub fn into_inner(self) -> yaml::Yaml {
         self.0.into_owned()
     }
diff --git a/src/yaml/write.rs b/src/yaml/write.rs
index a1e52a5..b7970b4 100644
--- a/src/yaml/write.rs
+++ b/src/yaml/write.rs
@@ -1,8 +1,10 @@
+/// TODO
 pub struct IoAdapter<'a, T: std::io::Write> {
     inner: &'a mut T,
 }
 
 impl<'a, T: std::io::Write> IoAdapter<'a, T> {
+    /// TODO
     pub fn new(writer: &'a mut T) -> Self {
         IoAdapter { inner: writer }
     }
-- 
cgit v1.2.3