docs(*): Clippy fixes with markdown docs

This commit is contained in:
Manish Goregaokar
2016-05-05 12:06:44 +05:30
parent 1d936fee90
commit b840963629
5 changed files with 20 additions and 20 deletions

View File

@@ -70,7 +70,7 @@ impl HeaderFormat for CacheControl {
}
}
/// CacheControl contains a list of these directives.
/// `CacheControl` contains a list of these directives.
#[derive(PartialEq, Clone, Debug)]
pub enum CacheDirective {
/// "no-cache"

View File

@@ -8,7 +8,7 @@ use header::parsing::from_one_raw_str;
/// client requests add one automatically.
///
/// Currently is just a String, but it should probably become a better type,
/// like url::Host or something.
/// like `url::Host` or something.
///
/// # Examples
/// ```

View File

@@ -64,8 +64,8 @@ pub enum Range {
Unregistered(String, String)
}
/// Each Range::Bytes header can contain one or more ByteRangeSpecs.
/// Each ByteRangeSpec defines a range of bytes to fetch
/// Each `Range::Bytes` header can contain one or more `ByteRangeSpecs`.
/// Each `ByteRangeSpec` defines a range of bytes to fetch
#[derive(PartialEq, Clone, Debug)]
pub enum ByteRangeSpec {
/// Get all bytes between x and y ("x-y")

View File

@@ -131,7 +131,7 @@ pub trait Header: Clone + Any + Send + Sync {
/// A trait for any object that will represent a header field and value.
///
/// This trait represents the formatting of a Header for output to a TcpStream.
/// This trait represents the formatting of a `Header` for output to a TcpStream.
pub trait HeaderFormat: fmt::Debug + HeaderClone + Any + Typeable + Send + Sync {
/// Format a header to be output into a TcpStream.
///
@@ -460,7 +460,7 @@ impl<'a> fmt::Display for &'a (HeaderFormat + Send + Sync) {
///
/// This can be used like so: `format!("{}", HeaderFormatter(&header))` to
/// get the representation of a Header which will be written to an
/// outgoing TcpStream.
/// outgoing `TcpStream`.
pub struct HeaderFormatter<'a, H: HeaderFormat>(pub &'a H);
impl<'a, H: HeaderFormat> fmt::Display for HeaderFormatter<'a, H> {