From a118f546126c4e307404315e91de56bd90e05448 Mon Sep 17 00:00:00 2001
From: Chris Wong <lambda.fairy@gmail.com>
Date: Fri, 6 Mar 2015 12:50:14 +1300
Subject: [PATCH] API comment conventions (rust-lang/rfcs#505)
---
maud/src/lib.rs | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/maud/src/lib.rs b/maud/src/lib.rs
index 1c6e397..ac4f789 100644
--- a/maud/src/lib.rs
+++ b/maud/src/lib.rs
@@ -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();
@@ -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,
@@ -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)
}