Merge pull request #24 from TaKO8Ki/fix-doc-comment

Fix doc comment

.github/workflows/release.yml

@@ -5,7 +5,7 @@ on:
       - 'v*'
 jobs:
   release:
-    name: Check version, Add tag and release
+    name: Cargo publish
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1

Cargo.toml

@@ -14,7 +14,7 @@ description = "A library for preparing test data from yaml files in Rust"
 repository = "https://github.com/TaKO8Ki/testfixtures"
 documentation = "https://docs.rs/testfixtures"
 readme = "README.md"
-keywords = ["test", "testdata", "db", "sqlx", "mysql"]
+keywords = [ "test", "testdata", "db", "sqlx", "mysql" ]
 categories = [ "database" ]
 
 [dependencies]

README.md

@@ -1,6 +1,6 @@
-# [WIP] testfixtures
+# testfixtures
 
-[![build]](https://github.com/TaKO8Ki/testfixtures/actions) [![docs]](#) [![license]](https://github.com/TaKO8Ki/testfixtures/blob/master/LICENSE) 
+[![build]](https://github.com/TaKO8Ki/testfixtures/actions) [![docs]](https://crates.io/crates/testfixtures) [![license]](https://github.com/TaKO8Ki/testfixtures/blob/master/LICENSE) 
 
 [build]: https://img.shields.io/github/workflow/status/TaKO8Ki/testfixtures/CI/master?logo=github
 [license]: https://img.shields.io/github/license/TaKO8Ki/testfixtures
@@ -35,12 +35,12 @@ Create fixture files like the following.
 `todos.yml`
 ```yml
 - id: 1
-  description: fizz
+  description: buy a new camera
   done: true
   progress: 10.5
   created_at: 2020/01/01 01:01:01
 - id: 2
-  description: buzz
+  description: meeting
   done: false
   progress: 30.0
   created_at: 2020/01/01 02:02:02

src/fixture_file.rs

@@ -57,7 +57,7 @@ mod tests {
     #[test]
     fn test_file_stem() -> anyhow::Result<()> {
         let dir = tempdir()?;
-        let file_path = dir.path().join("test.yml");
+        let file_path = dir.path().join("todos.yml");
         let fixture_file_path = file_path.clone();
         let mut file = File::create(file_path)?;
         writeln!(
@@ -83,14 +83,14 @@ mod tests {
             insert_sqls: vec![],
         };
 
-        assert_eq!(fixture_file.file_stem(), "test");
+        assert_eq!(fixture_file.file_stem(), "todos");
         Ok(())
     }
 
     #[test]
     fn test_delete() -> anyhow::Result<()> {
         let dir = tempdir()?;
-        let file_path = dir.path().join("test.yml");
+        let file_path = dir.path().join("todos.yml");
         let fixture_file_path = file_path.clone();
         let mut file = File::create(file_path)?;
         writeln!(
@@ -116,7 +116,7 @@ mod tests {
             insert_sqls: vec![],
         };
 
-        assert_eq!(fixture_file.delete(), "DELETE FROM test");
+        assert_eq!(fixture_file.delete(), "DELETE FROM todos");
         Ok(())
     }
 }

src/lib.rs

@@ -9,10 +9,14 @@
 //! ```yml
 //! - id: 1
 //!   description: buy a new camera
-//!   done: 0
+//!   done: true
+//!   progress: 10.5
+//!   created_at: 2020/01/01 01:01:01
 //! - id: 2
 //!   description: meeting
-//!   done: 0
+//!   done: false
+//!   progress: 30.0
+//!   created_at: 2020/01/01 02:02:02
 //! ```
 //!
 //!  ```rust
@@ -47,13 +51,9 @@ mod fixture_file;
 mod helper;
 mod loader;
 mod mysql;
-// mod postgresql;
 
-// reexport key APIs
 pub use fixture_file::{FixtureFile, InsertSql, SqlParam};
 pub use helper::Database;
 pub use loader::Loader;
 pub use mysql::helper::MySql;
 pub use mysql::loader::MySqlLoader;
-// pub use postgresql::helper::PostgreSql;
-// pub use postgres::loader::PgLoader;