Unify RST word / line wrap style

[dtrudg]

Which Document page:

Various

Expected results:

Consistent hard wrapped lines (80 column), or consistent long lines that assume editor word-wrapping.

Actual results:

A mix of hard wrapped and long lines between rst files, and within them in some cases.

[robertlugg]

What is the desired behavior? Is it hard-wrapped lines, or long lines?

[dtrudg]

Arghh - I meant to discuss this with the people who have been writing most of the doc.

I prefer hard wrapped 80, but that's since I am mostly writing markdown and linting which will complain if it's not wrapped.

@ikaneshiro - any preference?

[ikaneshiro]

@dctrud Hard wrapped at 80 seems better reasonable to me. Do we have a markdown linter in the CI for this repo?

[dtrudg]

The markdown is linted yes - but that's only the README.md

The rst files for the actual docs are now linted also - but RST linting isn't opinionated about line lengths it seems. It'd just be nice to have a standard for anyone editing. It's a pain when both hard and soft wrap is used in the same file.

On Mon, Oct 28, 2019 at 11:35 AM Ian Kaneshiro [email protected] wrote:

@dctrud https://github.com/dctrud Hard wrapped at 80 seems better reasonable to me. Do we have a markdown linter in the CI for this repo?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/sylabs/singularity-userdocs/issues/253?email_source=notifications&email_token=ABCQGLZCTEV4U4E6MYAENT3QQ4ID5A5CNFSM4I4ZJIJ2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOECNQ75I#issuecomment-547033077, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABCQGLYZI7P5M5ZQ6E33E53QQ4ID5ANCNFSM4I4ZJIJQ .

-- David Trudgian Sylabs Inc. www.sylabs.io

[WestleyK]

I also agree; hard wrapping to 80 characters per line. Its way nicer to review/edit when lines are limited. Otherwise it gets annoying having to scroll thought a 300+ character line, Imo.

[dtrudg]

I'm hard wrapping 80 as I go. I still haven't found something nice to lint this and allow long lines where necessary for code blocks, links etc.

I'm editing in emacs fwiw, and fill-paragraph M-q works nicely on RST without messing up any syntax or adding breaks to references etc.