From b47e58cef77650b0afa523777eb05ef3f4e1534a Mon Sep 17 00:00:00 2001 From: Mika Ivarsson <13712961+Mojken@users.noreply.github.com> Date: Fri, 10 Apr 2026 19:07:06 +0200 Subject: [PATCH] Fix table in README.md It was indented too far --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1fedb48..cc8add2 100644 --- a/README.md +++ b/README.md @@ -53,11 +53,11 @@ So: ### Q: How do I document my endpoints? A: Okapi automatically uses the [Rust Doc Comments](https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html) from most places, this includes: - - Endpoint functions. - - Endpoint function arguments, using [Schemars][Schemars]. Adding documentation for `String` + - Endpoint functions. + - Endpoint function arguments, using [Schemars][Schemars]. Adding documentation for `String` and other default types is not possible unless used in an other `struct`. See [this issue for more info](https://github.com/GREsau/okapi/issues/102#issuecomment-1152918141). - - Endpoint function return type, using [Schemars][Schemars]. Same rules apply as arguments. + - Endpoint function return type, using [Schemars][Schemars]. Same rules apply as arguments. In case of `Result`, the error codes can be documented, [see this example](https://github.com/GREsau/okapi/blob/master/examples/custom_schema/src/error.rs).