Skip to content

PR diffs, and git commits, are harder to read than they could be #2463

Closed
@kpinc

Description

@kpinc

Hi,

I notice that the convention, in at least some files, is to line-break at the end of paragraphs. This makes diffs harder to read.

For example, look at the diff of PR #2416 at lines 245/248 (old/new). The change is that a new sentence was added to the end of the paragraph. But this is hard to see without close reading. If some comma was added somewhere in the middle of the paragraph it would be difficult to notice.

While this might be improved by a change to the git web interface, that does not help when using git itself, doing diffs while developing, etc.

So, I write this to suggest that the source code for the docs have line breaks after every sentence. I've seen this convention elsewhere, but can't recall where.

Enforcing this suggestion might be too much to ask, but it wouldn't hurt to consider adopting the practice and encouraging it's use.

Regards,
Karl

Metadata

Metadata

Assignees

Labels

DaWGsGood discussion item for the DaWGs

Type

No type

Projects

Status

✅ Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions