#267 Limit to one sentence per line
Closed: complete 3 years ago by ankursinha. Opened 3 years ago by t0xic0der.

This issue crept up when I edited the document for GSoC to correct typographical mistakes. It is always convenient to review diffs in such a state.


Hrm, no, I think the guideline is to have one sentence per line because git does line by line diffs, and this allows us to verify changes on a per sentence basis.

Limiting a line width to 80 characters is troublesome with docs, primarily because changing the sentence will wrap the text around and move bits to different lines. (The 80 character rule is much debated nowadays, and in general, given the increased screen size nowadays is left up to personal preference.)

I think a "Limit each sentence to a line" makes sense, but I don't see the advantage of "limiting each line to 80 characters". A better rule that improves readability would be "avoid long sentences because they reduce readability", and that would avoid the "long scrolling" issue.

Metadata Update from @ankursinha:
- Issue untagged with: good first issue
- Issue tagged with: needs info

3 years ago

Yes. I seem to have misunderstood the suggestion at https://pagure.io/mentored-projects/pull-request/84. A sentence per line seems to be the norm rather than having it restricted to 80-chars (which otherwise can break links too).

@ankursinha I will make those changes.

Sounds good. I'll close this ticket then.

Metadata Update from @ankursinha:
- Issue close_status updated to: complete
- Issue status updated to: Closed (was: Open)

3 years ago

Umm. @ankursinha. There are docs which haven't followed the one sentence per line norm. We can keep this issue open until all those documents are addressed.

Hrm, no, it'll be much better to open individual tickets for each quick-docs so that they can each be closed when the doc has been fixed. Otherwise, it's hard to track progress in this one ticket using comments (and we don't expect someone to go through all the docs to fix them all in one go to fix this issue)

That's one of the checks that are made when each doc is reviewed---lots of them still pending at the moment, unfortunately.

If you wish, this can be kept open as a "tracker ticket" perhaps?

If keeping this on as a "tracker ticker" helps, we can keep it on. Else, the issue per document makes a lot more sense.

Login to comment on this ticket.

Metadata