Skip to content

Commit

Permalink
API comment conventions (rust-lang/rfcs#505)
Browse files Browse the repository at this point in the history
  • Loading branch information
lambda-fairy committed Mar 5, 2015
1 parent 74475f9 commit a118f54
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions maud/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@
use std::fmt;
use std::io;

/// Escape an HTML value.
/// Escapes an HTML value.
pub fn escape(s: &str) -> String {
use std::fmt::Write;
let mut buf = String::new();
Expand All @@ -175,7 +175,7 @@ pub struct Markup<F> {
}

impl<F> Markup<F> where F: Fn(&mut fmt::Write) -> fmt::Result {
/// Render the markup to a `std::io::Write`.
/// Renders the markup to a `std::io::Write`.
pub fn render<W: io::Write>(&self, w: &mut W) -> io::Result<()> {
struct Adaptor<'a, W: ?Sized + 'a> {
inner: &'a mut W,
Expand All @@ -201,7 +201,7 @@ impl<F> Markup<F> where F: Fn(&mut fmt::Write) -> fmt::Result {
}
}

/// Render the markup to a `std::fmt::Write`.
/// Renders the markup to a `std::fmt::Write`.
pub fn render_fmt(&self, w: &mut fmt::Write) -> fmt::Result {
(self.callback)(w)
}
Expand Down

0 comments on commit a118f54

Please sign in to comment.