Skip to content

Commit 0fe926f

Browse files
committed
Update README.md
1 parent 3655473 commit 0fe926f

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

.github/workflows/release.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ jobs:
3535
- uses: katyo/publish-crates@v1
3636
with:
3737
registry-token: ${{ secrets.CARGO_REGISTRY_TOKEN }}
38-
path: packages/validation/
3938

4039
- name: Update deployment status (success)
4140
if: success()

Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ name = "rocket-validation"
33
version = "0.1.0"
44
edition = "2021"
55
license = "MIT"
6-
readme = "../../Readme.md"
6+
readme = "README.md"
77
repository = "https://github.com/somehowchris/rocket-validation"
8-
keywords = ["rocket", "validation", "json", "query", "data", "validator"]
8+
keywords = ["rocket", "validation", "json", "data", "validator"]
99
categories = ["web-programming"]
1010
rust-version = "1.56.0"
1111
description = "Rocket Guards to support validation using validator"

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,5 @@ fn rocket() -> _ {
6666
.mount("/", routes![validated_hello])
6767
.register("/", catchers![rocket_validation::validation_catcher])
6868
}
69-
```
69+
```
70+
> Currently limited to `Json` or `FromData` validations due to inernal rocket limitations

src/lib.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ impl<'r, D: Validate + rocket::serde::Deserialize<'r>> FromData<'r> for Validate
195195
}
196196
}
197197

198-
/// Implementation of `Validated` for `FromRequest`
198+
/// Implementation of `Validated` for `FromRequest` implementing `Validate`
199199
//
200200
/// Anything you implement `FromRequest` for as well as `Validate`
201201
#[rocket::async_trait]
@@ -218,9 +218,9 @@ impl<'r, D: Validate + FromRequest<'r>> FromRequest<'r> for Validated<D> {
218218
}
219219
}
220220

221-
// TODO Fix doc
222221
/// Implementation of `Validated` for `FromForm`
223-
/// An example with `Json`
222+
///
223+
/// An example validating a query struct
224224
/// ```rust
225225
/// # #[macro_use] extern crate rocket;
226226
/// use rocket::serde::{json::Json, Deserialize, Serialize};

0 commit comments

Comments
 (0)