Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jbearer committed Jun 5, 2024
1 parent 131baa0 commit 859d6bd
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions src/healthcheck.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use serde::{Deserialize, Serialize};
/// A type implementing [HealthCheck] may be returned from a healthcheck endpoint itself (via its
/// [Serialize] implementation) as well as incorporated automatically into the global healthcheck
/// endpoint for an app. The global healthcheck will fail if any of the module healthchecks return
/// an implementation `h` of [HealthCheck] where `h.status() != StatusCode::Ok`.
/// an implementation `h` of [HealthCheck] where `h.status() != StatusCode::OK`.
///
/// We provide a standard implementation [HealthStatus] which has variants for common states an
/// application might encounter. We recommend using this implementation as a standard, although it
Expand All @@ -21,7 +21,7 @@ use serde::{Deserialize, Serialize};
pub trait HealthCheck: Serialize {
/// The status of this health check.
///
/// Should return [StatusCode::Ok] if the status is considered healthy, and some other status
/// Should return [StatusCode::OK] if the status is considered healthy, and some other status
/// code if it is not.
fn status(&self) -> StatusCode;
}
Expand Down
2 changes: 1 addition & 1 deletion src/listener.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ use tide::{

/// TCP listener which accepts only a limited number of connections at a time.
///
/// This listener is based on [`tide::listener::TcpListener`] and should match the semantics of that
/// This listener is based on `tide::listener::TcpListener` and should match the semantics of that
/// listener in every way, accept that when there are more simultaneous outstanding requests than
/// the configured limit, excess requests will fail immediately with error code 429 (Too Many
/// Requests).
Expand Down
2 changes: 1 addition & 1 deletion src/request.rs
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ impl RequestParams {
///
/// impl From<RequestError> for ApiError {
/// fn from(err: RequestError) -> Self {
/// Self::catch_all(StatusCode::BadRequest, err.to_string())
/// Self::catch_all(StatusCode::BAD_REQUEST, err.to_string())
/// }
/// }
///
Expand Down

0 comments on commit 859d6bd

Please sign in to comment.