search

mpiwg-tools / tools-issues

Tickets and Wiki for the MPI-Forum Tools Working Group
13 stars 2 forks source link

Fix whitespace in chapter sources #7

Closed mahermanns closed 8 years ago

mahermanns commented 8 years ago

Problem

The LaTeX source formatting in the tools chapter does not follow any convention. Changes either lead to further degradation of the formatting or will show more changes in the source than actually performed due to re-formatting.

Proposed solution

Having a single line per sentence allows changes, such as adding or changing a single word to be readily seen in the diff of the change.

Implementation

Each paragraph should be reformatted to have individual sentences formatted to a single line each.

The resulting PDF should show now change compared to the PDF created from the unformatted source.

mahermanns commented 8 years ago

Fixed whitespace sources: mpi32-report_fix_whitespace.pdf Original sources: mpi32-report.pdf

mahermanns commented 8 years ago

From the March 2016 Forum meeting discussions, we noted that most of the people editing the sources prefer the "text wrapped at column X" style. Also, the Github diff can also find the changed words within a re-wrapped paragraph, resulting in a manageable diff for reviews.