Line wrap convention?

[alexreg]

Line wrap convention?

[mark-i-m]

I don't think there is a hard style guide... I personally prefer hard wrapping at 80chars. If this was code, I would say "use rustfmt", but I have no strong preference for markup files.

Feel free to pick a convention. If you do, please add a note in the README. This could be turned a tracking issue of files that need to be properly formatted.

Let me know what you think :)

[alexreg]

Hard-wrapping at 80, and keeping formatted parts (backticks, bold, underline) on their own line seems to make the most sense to me. Is there a tool that can automatically do this?

[mark-i-m]

Is there a tool that can automatically do this?

Unfortunately, I don't know. I usually just use vim (gqgq)...

[mark-i-m]

Oh wait, do you mean for this repo?

Yep, since it is mostly markdown rustfmt doesn't help :'( On Feb 5, 2018 1:21 AM, "Vadim Petrochenkov" <[email protected]> wrote: Oh wait, do you mean for this repo? — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#42 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AIazwPDoWzrV0gmWdMoorD93e5OUPQ0Hks5tRqvdgaJpZM4R4u2B> .

[alexreg]

Hmm, we may be able to use the GNU fmt utility for this, and integrate it into the build script?

[mark-i-m]

I'm not familiar with fmt, but it sounds promising. I think the best thing would be to have some sort of tidy check that is run by travis. That way a PR gets blocked until formatting is fixed.

[alexreg]

Yeah, that could work too. Should be pretty easy to write a Bash script that does that.

[nikomatsakis]

I'm generally in favor of line wrapping -- it makes the text much more readable when it's not rendered, and it can help make diffs more readable -- though I see the advantage of not doing it too. I don't know about tooling for doing it; I also just hit M-q in emacs to do it. I suppose fmt might work?

[alexreg]

I've seen some odd line wrapping conventions around the Rust codebase (70 chars?!), and even though I prefer not line wrapping (I prefer to leave it to the text editor / renderer), it seems like most people like it... so as long as we could standardise it, and put a check on the CI, that could work. (I just tried fmt -w 80 here, which works nicely for Markdown.

[mark-i-m]

Thanks for the investigation @alexreg :)

Would you mind make a PR to add such a check to the CI?

[alexreg]

@mark-i-m Sure, that should be simple enough...