oss-generic / process

The OSS-Generic Reference Process
https://oss-generic.github.io/process/
MIT License
6 stars 19 forks source link

Specify line wrapping rules for markdown files #83

Open damithc opened 7 years ago

damithc commented 7 years ago

I'm wondering if line wrapping is necessary for markdown files (or any files for that matter). Apparently, Github can show the code with soft wraps and I suppose IDEs can do this too? In that case, inserting hard line breaks seem like a waste of effort.

image

yamgent commented 7 years ago

Yes, in fact I feel that inserting hard line break should be discouraged for markdown documentation. Adding new words or removing words will make the wrapping out of sync, and correcting it will just add noise to the diff.

damithc commented 7 years ago

Yes, in fact I feel that inserting hard line break should be discouraged for markdown documentation. Adding new words or removing words will make the wrapping out of sync, and correcting it will just add noise to the diff.

I feel the same way.

I wish we could do the same in more places, such as commit message body and javadoc comments (basically, places where we use prose).