Skip to content
This repository has been archived by the owner on May 28, 2022. It is now read-only.

Specify line wrapping rules for markdown files #83

Open
damithc opened this issue Mar 25, 2017 · 2 comments
Open

Specify line wrapping rules for markdown files #83

damithc opened this issue Mar 25, 2017 · 2 comments

Comments

@damithc
Copy link
Contributor

damithc commented Mar 25, 2017

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
Copy link
Contributor

yamgent commented Mar 26, 2017

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
Copy link
Contributor Author

damithc commented Mar 26, 2017

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).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants