[MERGE][0.17] sanitize developers docs
John Arbash Meinel
john at arbash-meinel.com
Mon Jun 4 17:14:56 BST 2007
John Arbash Meinel has voted +0.
Status is now: Semi-approved
Comment:
I want us to end up with consistent documentation styles, but I slightly
disagree with this convention.
I also think we have been using .txt for all of our documentation, and
if it isn't auto-compiled, then we just need to fix the Makefile to do
it. (I know you have to name it doc/*.txt, but maybe the current
makefile expects doc/developers/*.rst ?)
I personally prefer .rst since it makes Vim highlight correctly
automatically. However on platforms like Windows, using .txt means it
will recognize it and let you open it, rather than just prompting you
about an unknown file extension. (Though I guess Notepad will be unhappy
about \n endings instead of \r\n).
So I'm personally biased towards .rst, but we have used .txt to this
point.
I don't think performance.dot is currently referenced, though it might
be nice to build up a make dependency chain so that we can build the
image (dot -Tpng -o performance.png performance.dot should be enough)
and then have a document which mentions it. (and maybe discusses it a
little bit).
For details, see:
http://bundlebuggy.aaronbentley.com/request/%3C4663EB64.2010808%40ukr.net%3E
More information about the bazaar
mailing list