Skip to content

Fix table in README.md #170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mojken wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix table in README.md #170

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<T, E>`, the error codes can be documented,
[see this example](https://github.com/GREsau/okapi/blob/master/examples/custom_schema/src/error.rs).

Expand Down