Formatting for documentation source code

Halo · 08-14-2011, 09:36 PM

There doesn't seem to be any standard to how the source code for the documentation is formatted. Some lines wrap at one length while others are at longer lengths. Some have whole paragraphs on a single line.

Would there be any objection if I were to wrap lines at 78 characters as I make edits to the documentation? I would only change the lines or paragraphs that I edit for content. Alternatively, if there is consensus on a standard, I would be happy to reformat all of the doc source and submit it in a single commit.

I would also like to include some "vim hints" at the beginning or end of each doc source file to help enforce editor setting consistency, provided no one objects.

kovidgoyal · 08-14-2011, 09:39 PM

I have no objections to either.

08-14-2011, 09:36 PM	#1
Halo Connoisseur Posts: 96 Karma: 72130 Join Date: Nov 2008 Location: San Francisco Bay Area, CA, USA Device: Sony PRS-505, Kindle DX 1st Gen, Kindle Fire 1st Gen	Formatting for documentation source code There doesn't seem to be any standard to how the source code for the documentation is formatted. Some lines wrap at one length while others are at longer lengths. Some have whole paragraphs on a single line. Would there be any objection if I were to wrap lines at 78 characters as I make edits to the documentation? I would only change the lines or paragraphs that I edit for content. Alternatively, if there is consensus on a standard, I would be happy to reformat all of the doc source and submit it in a single commit. I would also like to include some "vim hints" at the beginning or end of each doc source file to help enforce editor setting consistency, provided no one objects.

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
Help formatting Source Code	frios	ePub	3	07-15-2011 08:06 AM
Let's create a source code repository for DR 800 related code?	jraf	iRex	3	03-11-2010 12:26 PM
Source code available	AlfonsVH	HanLin eBook	3	01-03-2009 02:30 PM
prflrf source code?	daqi	Sony Reader Dev Corner	5	04-22-2008 11:28 AM
source code??	joblack	iRex	1	11-01-2006 12:16 PM

08-14-2011, 09:39 PM	#2
kovidgoyal creator of calibre Posts: 43,860 Karma: 22666666 Join Date: Oct 2006 Location: Mumbai, India Device: Various	I have no objections to either.

Advert