Confessions of a researchaholic

September 3, 2018

Writing style for revision control Latex source

Filed under: Real — liyiwei @ 2:27 pm
Tags:

Put one, or at most a few, complete sentence(s) into one line.
Latex treats line breaks as spaces, so the compiled document will still have the correct formation.

Since popular revision control tools like git/svn are based on line diff, putting too many sentences in one line will cause excessive revision differences and obscure the actual changes.

Avoid artificial line breaks in the middle of the sentences, which tend to confuse the spell-checkers and the git/svn line diff.

Leave a Comment »

No comments yet.

RSS feed for comments on this post. TrackBack URI

Leave a Reply

Your email address will not be published.

 

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Theme: Rubric. Get a free blog at WordPress.com