Jump to content

Topic on Manual talk:Coding conventions/Flow

Novem Linguae (talkcontribs)

So the limit of 100 characters per line seems like it has some pros and cons. Pros are that folks who don't have word wrapped turned on get a better experience. Cons is developers have to spend time manually doing and fixing comment line breaks. It also seems to me that all modern code editors have word wrap. So I guess my question is, are there still folks that don't have word wrap turned on? Is this a Linux thing? Just curious. Thanks!

DKinzler (WMF) (talkcontribs)

In my experience, anything that uses meaningful indendation becames hard to read when using soft-wrap. Modern code editors have gotten much better at this, but it's still not great. It works fine for a long single line comment. But it really falls apart for a complex doc block.

Here's an example of PhpStorm soft-wrapping the documentation of the LocalFileRepo configuration to 80 characters: https://phabricator.wikimedia.org/F57770695

I much prefer the line onds on the righthand side to be cut off when casually browsing.

If we were to rely on soft wrapping entirely, I suppose a big doc block would "physically" be a single line? That would also make diffs much harder to read, since they are line base.

Nikerabbit (talkcontribs)
Reply to "max-len"