I (Julian Foad) wrote: > Are these doc strings and comments good? Sometimes I don't use enough words.
I believe these additions are helpful, not so much because they provide high density and hard-to-discover info (they don't, yet), but because they provide a solid starting point for expanding as the functions evolve to become more permanent and more complex. Having these as starting points lowers the bar for adding documentation of any non-trivial behaviours by indicating that some consideration has already been made of the basics, and provides a quicker reference for the reader than the alternative which was to search up and down the file for where and how the function was used as a clue to its purpose and API. So all I'm asking is: is there anything incorrect or a very bad idea in this patch? - Julian
