Merge pull request #134 from banyancomputer/docs_cleanup

Docs cleanup
banyancomputer · Mar 9, 2023 · eb3ed06 · eb3ed06
2 parents 4c0fc70 + 4fc7bab
commit eb3ed06
Show file tree

Hide file tree

Showing 23 changed files with 428 additions and 478 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -20,7 +20,6 @@ tokio = { version = "1.24", features = ["full", "io-util", "fs"]}
 tokio-stream = { version = "0.1.11", features = ["fs"]}
 jwalk = "0.8.1"
 rand = "0.8.4"
-blake2 = "0.10.6"
 uuid = { version = "1.2.2", features = ["v4"]}
 serde ={version= "1.0.152", features = ["derive"]}
 serde_json = { version = "1.0.72", features = ["std"]}

diff --git a/dataprep-lib/Cargo.toml b/dataprep-lib/Cargo.toml
@@ -13,7 +13,6 @@ anyhow.workspace = true
 tokio.workspace = true
 tokio-stream.workspace = true
 jwalk.workspace = true
-blake2.workspace = true
 uuid.workspace = true
 serde.workspace = true
 serde_json.workspace = true

diff --git a/dataprep-lib/benches/pipeline.rs b/dataprep-lib/benches/pipeline.rs
@@ -320,9 +320,9 @@ fn pack_benchmark(
             // The routine to benchmark
             |_| async {
                 pack_pipeline(
-                    black_box(input_path.clone()),
-                    black_box(packed_path.clone()),
-                    black_box(manifest_path.clone()),
+                    black_box(input_path),
+                    black_box(packed_path),
+                    black_box(manifest_path),
                     // TODO (amiller68) - make this configurable
                     black_box(1073741824),
                     black_box(false),
@@ -368,14 +368,7 @@ fn unpack_benchmark(
             // Operation needed to make sure unpack doesn't fail
             || prep_unpack(unpacked_path, manifest_path),
             // The routine to benchmark
-            |_| async {
-                unpack_pipeline(
-                    black_box(packed_path.clone()),
-                    black_box(unpacked_path.clone()),
-                    black_box(manifest_path.clone()),
-                )
-                .await
-            },
+            |_| async { unpack_pipeline(black_box(unpacked_path), black_box(manifest_path)).await },
             // We need to make sure this data is cleared between iterations
             // We only want to use one iteration
             BatchSize::PerIteration,

diff --git a/dataprep-lib/src/do_pipeline_and_write_metadata/mod.rs b/dataprep-lib/src/do_pipeline_and_write_metadata/mod.rs
@@ -1,2 +1,4 @@
+/// This module contains the pack_pipeline function, which is the main entry point for packing new data.
 pub mod pack_pipeline;
+/// This module contains the unpack_pipeline function, which is the main entry point for extracting previously packed data.
 pub mod unpack_pipeline;