Skip to content

Line wrap docs#421

Draft
jhbaarnh wants to merge 1 commit intointel:mainfrom
jhbaarnh:line-wrap
Draft

Line wrap docs#421
jhbaarnh wants to merge 1 commit intointel:mainfrom
jhbaarnh:line-wrap

Conversation

@jhbaarnh
Copy link
Contributor

This makes it easier to read them.

This makes it easier to read them.
@mandolaerik
Copy link
Contributor

Line wrapped .md is problematic, because in order to maintain line wrappings you need to re-wrap which makes diffs harder to read. Therefore it was suggested (by @aconradi IIRC) that we keep a less strict policy for md, where we linebreak after each sentence instead of 80 chars. This makes sense to me.

But thinking about it, there is not really a problem with breaking both after sentences and before 80 chars. Whether or not this makes sense depends on editor support, I suppose.

@jhbaarnh
Copy link
Contributor Author

Ok when I write documentation I'll always line wrap anyway as a matter of course, it's just M-q in emacs after all. And the diff modes I've used most (e.g. both Emacs and Github) clearly highlight which words have changed in a paragraph, even if it's reflowed so it seems to not really be a problem.

But it is currently hard to look at and edit the markdown source in Emacs since the lines are so long.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants