[merge] small get_record_stream docs

[John Arbash Meinel]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Martin Pool wrote:
> This adds a little more text and fixes up rest formatting in the
> get_record_stream documentation.  (It's left over from when I was
> looking at this a while ago.)
> 
> 

Overall the documentation cleanup seems fine. I don't think all of it is
100% accurate. With get_record_stream() being available the generic api
doesn't *always* cast all the way up to full-texts.

...

+* compressor_data: Required opaque data relevant to the storage_kind.
+  (This is set to None when the compressor has no special state needed)
+


I've never seen a "compressor_data" attribute, so I'm pretty sure this
is cruft.

John
=:->

BB:tweak
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iEYEARECAAYFAklBfs4ACgkQJdeBCYSNAANIyQCfYaa3rceOrBRVQh5R43Hc0AII
NcgAoJVNsD5nYKCYyYXvL338bLeawr4c
=Fnew
-----END PGP SIGNATURE-----