From 78bc10d94bcaecbc45687b82e82dd46a79cd29b3 Mon Sep 17 00:00:00 2001
From: Dan Luu <danluu@gmail.com>
Date: Sat, 13 Apr 2013 16:17:30 -0400
Subject: [PATCH] Doc review, as requested :-).

Mostly just phrasing things differently, which is a matter of taste. Feel free to use or not use any of the changes I'm suggesting.

I would say this one thing should be changed, though, not necessarily the way I changed it here.

     * Convert any string (literal, `@`, `&`, `~`)
     * that contains a base64 encoded value, to the byte values it encodes.

If this structure is going to be used, either the entire clause, 'that contains a base64 encoded value', should be bracketed by commas, or the comma at the end of the clause should be removed.
---
 src/libstd/base64.rs | 15 +++++++--------
 1 file changed, 7 insertions(+), 8 deletions(-)

diff --git a/src/libstd/base64.rs b/src/libstd/base64.rs
index 5b1e82ce1f00e..054f3a2b10839 100644
--- a/src/libstd/base64.rs
+++ b/src/libstd/base64.rs
@@ -28,7 +28,7 @@ static CHARS: [char, ..64] = [
 
 impl<'self> ToBase64 for &'self [u8] {
     /**
-     * Turn a vector of `u8` bytes into a string representing them in base64.
+     * Turn a vector of `u8` bytes into a base64 string.
      *
      * *Example*:
      *
@@ -92,7 +92,7 @@ impl<'self> ToBase64 for &'self [u8] {
 
 impl<'self> ToBase64 for &'self str {
     /**
-     * Convert any string (literal, `@`, `&`, `~`) to base64 encoding.
+     * Convert any string (literal, `@`, `&`, or `~`) to base64 encoding.
      *
      *
      * *Example*:
@@ -119,8 +119,8 @@ pub trait FromBase64 {
 
 impl FromBase64 for ~[u8] {
     /**
-     * Turn a vector of `u8`s representing characters
-     * encoding byte values in base64 into the vector of `u8` byte values.
+     * Convert base64 `u8` vector into u8 byte values.
+     * Every 4 encoded characters is converted into 3 octets, modulo padding.
      *
      * *Example*:
      *
@@ -200,16 +200,15 @@ impl FromBase64 for ~[u8] {
 
 impl FromBase64 for ~str {
     /**
-     * Convert any string (literal, `@`, `&`, `~`)
-     * that contains a base64 encoded value, to the byte values it encodes.
+     * Convert any base64 encoded string (literal, `@`, `&`, or `~`)
+     * to the byte values it encodes.
      *
      * You can use the `from_bytes` function in `core::str`
      * to turn a `[u8]` into a string with characters corresponding to those values.
      *
      * *Example*:
      *
-     * This is an example of going from a string literal to the base64 encoding
-     * and back to the same string.
+     * This converts a string literal to base64 and back.
      *
      * ~~~~
      * extern mod std;