[TYPO3-doc] reST DocTemplate for Extension Developer - first draft

Fabien Udriot fabien.udriot at ecodev.ch
Fri Apr 27 11:26:33 CEST 2012



On 4/26/12 7:34 PM, Martin Bless wrote:
> Hi Jigal,
> 
>> Reformatting text in paragraphs is not very nice for VCS. If an entire 
>> paragraph of 10 lines is reformatted because a single word was changed, 
>> it is very hard to read the changes.
> 
> I tried to express: You don't have to reformat everything. Just insert
> the word where it belongs.

I understand your point that not having optimal packed paragraph is not an issue (though, it looks
better if that is not too much messed up from a readability perspective).

My concern is the annoyance of having automatic return by typing long URL getting constantly broken
by the editor or, as another example, copying code snippet that get reformatted (which is honestly a
pain!).

I am currently using PyCharm as reST editor that I appreciate - although not free - for its syntax
highlighting and I really prefer the soft wrapping that adapts itself to the screen. If someone
doesn't like long lines on the screen, he could resize its window to get a smaller paragraph length.

It is about details that the make the writing process comfortable.

Cheers,

Fabien


More information about the TYPO3-project-documentation mailing list