Document configurable CSV delimiter and bump patch version

NiklasEi · Jan 17, 2024 · 9c437a4 · 9c437a4
1 parent 8cdd13a
commit 9c437a4
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Changelog
 
+## v0.9.1 - 17.01.2024
+- CsvAssetPlugin supports configuring the delimiter with `with_delimiter`
+
 ## v0.9.0 - 07.01.2024
 - Add support for CSV files
 

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "bevy_common_assets"
-version = "0.9.0"
+version = "0.9.1"
 authors = ["Niklas Eicker <git@nikl.me>"]
 edition = "2021"
 license = "MIT OR Apache-2.0"

diff --git a/src/csv.rs b/src/csv.rs
@@ -41,6 +41,21 @@ where
     }
 
     /// Change the delimiter used to parse the CSV file.
+    ///
+    /// The default is ","
+    ///
+    /// ```no_run
+    /// # use bevy::prelude::*;
+    /// # use bevy_common_assets::csv::CsvAssetPlugin;
+    /// App::new()
+    ///     .add_plugins(CsvAssetPlugin::<TreePosition>::new(&["some_file.csv"]).with_delimiter(b';'));
+    /// # #[derive(serde::Deserialize, Asset, TypePath, Debug)]
+    /// # struct TreePosition {
+    /// #     x: f32,
+    /// #     y: f32,
+    /// #     z: f32,
+    /// # }
+    /// ```
     pub fn with_delimiter(mut self, delimiter: u8) -> Self {
         self.delimiter = delimiter;
         self