[MERGE][0.17] sanitize developers docs

Robert Collins robertc at robertcollins.net
Tue Jun 5 05:18:45 BST 2007


On Mon, 2007-06-04 at 12:14 -0400, John Arbash Meinel wrote:

> 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 prefer .txt, with a innocuous vim: line in it :).

-Rob
-- 
GPG key available at: <http://www.robertcollins.net/keys.txt>.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20070605/b0299982/attachment-0001.pgp 


More information about the bazaar mailing list