mirror of
https://github.com/deuxfleurs-org/garage.git
synced 2026-08-10 06:26:52 +00:00
docs: add missing backticks in documentation
this improve readability of documentation. enable associated clippy lint `doc_markdown`
This commit is contained in:
+2
-2
@@ -97,7 +97,7 @@ impl ReturnFormat {
|
||||
}
|
||||
}
|
||||
|
||||
/// Handle ReadItem request
|
||||
/// Handle `ReadItem` request
|
||||
#[allow(clippy::ptr_arg)]
|
||||
pub async fn handle_read_item(
|
||||
ctx: ReqCtx,
|
||||
@@ -201,7 +201,7 @@ pub async fn handle_delete_item(
|
||||
.body(empty_body())?)
|
||||
}
|
||||
|
||||
/// Handle ReadItem request
|
||||
/// Handle `ReadItem` request
|
||||
#[allow(clippy::ptr_arg)]
|
||||
pub async fn handle_poll_item(
|
||||
ctx: ReqCtx,
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
//! Utility module for retrieving ranges of items in Garage tables
|
||||
//! Implements parameters (prefix, start, end, limit) as specified
|
||||
//! for endpoints ReadIndex, ReadBatch and DeleteBatch
|
||||
//! for endpoints `ReadIndex`, `ReadBatch` and `DeleteBatch`
|
||||
|
||||
use std::sync::Arc;
|
||||
|
||||
|
||||
@@ -53,7 +53,7 @@ pub enum Endpoint {
|
||||
impl Endpoint {
|
||||
/// Determine which S3 endpoint a request is for using the request, and a bucket which was
|
||||
/// possibly extracted from the Host header.
|
||||
/// Returns Self plus bucket name, if endpoint is not Endpoint::ListBuckets
|
||||
/// Returns Self plus bucket name, if endpoint is not `Endpoint::ListBuckets`
|
||||
pub fn from_request<T>(req: &Request<T>) -> Result<(Self, String), Error> {
|
||||
let uri = req.uri();
|
||||
let path = uri.path().trim_start_matches('/');
|
||||
|
||||
Reference in New Issue
Block a user