Updating documentation

Roman Leshchinskiy rl at cse.unsw.edu.au
Mon Nov 8 08:45:04 EST 2010

On 8 Nov 2010, at 12:50, Johan Tibell <johan.tibell at gmail.com> wrote:

> "O(n) The 'intercalate' function takes a 'ByteString' and a list of
> 'ByteString's and concatenates the list after interspersing the first
> argument between each element of the list."

I don't think this is a very good bit of documentation. It basically retells the type signature in its own words.

> We can change the style of the @id@ markup, it's orthogonal to the
> hyperlinking issue. I personally like the style use in
>  http://code.google.com/appengine/docs/python/datastore/modelclass.html
> where identifier are monospace but appear in a color that makes them
> stand out a little bit more.

Yes! Perhaps we should also make them clickable ;-)



More information about the Libraries mailing list