document take

makcandrov · Sep 29, 2024 · 08b40f1 · 08b40f1
1 parent 5ec1a18
commit 08b40f1
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "quick-impl"
-version = "0.1.2"
+version = "0.1.3"
 edition = "2021"
 repository = "https://github.com/makcandrov/quick-impl"
 homepage = "https://github.com/makcandrov/quick-impl"

diff --git a/README.md b/README.md
@@ -25,6 +25,7 @@
 - `get_mut` - A mutable getter for the field.
 - `into` - Converts the structure into the field.
 - `set` - A setter for the field.
+- `take` - Returns the field and replaces it with its default value.
 - `with` - Returns the sutrcture with the field modified.
 
 ### Structures traits

diff --git a/src/components/structs/methods/take.rs b/src/components/structs/methods/take.rs
@@ -9,7 +9,7 @@ use crate::tokens::IndexedField;
 build_enum_name! { ConfigName, "take_{}" }
 build_enum_doc! {
     ConfigDoc,
-    "Replaces the field `{1}` of [`{0}`] with its default value.",
+    "Returns the field `{1}` of [`{0}`] and replaces it with its default value.",
 }
 
 build_config! {