[
https://issues.apache.org/jira/browse/SOLR-10749?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16032398#comment-16032398
]
Erick Erickson commented on SOLR-10749:
---------------------------------------
-1 on enforcing line length. The argument that we enforce line wrapping in code
is apples-oranges IMO. In code both readability and correctness are sensitive
to line breaks
someObject.getSomethng().dosomething()
or
someObject.getSomethng().
dosomething()
or even
someObject.getSomething()
.dosomething()
all hang together.
But
someObject.get
Somethng().dosomething()
not only is hard to follow, it fails compilation.
Text is a different beast. If I have to adjust all of the lines in a paragraph
because I want to add three words to the first sentence I'll go mad. Requiring
each new sentence to start after a hard break would make very spaced-out
documents or ones that are visually unappealing. Isn't the usual standard here
that hard breaks do a 1.5 spacing where soft breaks are 1.0? So new paragraphs
have a bit of extra space from the last sentence of the previous paragraph.
Besides, a single sentence could easily go over 120 characters (or whatever the
limit would be), does that now require a hard line break too? How would that be
distinguished from the user-entered hard breaks at the end of sentences? Line
length is really a null concept in flowed text, paragraphs are what count.
I confess that I don't particularly like the vertical pane splitting in the
IntelliJ IDE, haven't figured out how to make it horizontal instead, but even
so seeing the text appear in its final format as I type is _really_ helpful...
> Should ref guide asciidoc files' line length be limited?
> --------------------------------------------------------
>
> Key: SOLR-10749
> URL: https://issues.apache.org/jira/browse/SOLR-10749
> Project: Solr
> Issue Type: Sub-task
> Security Level: Public(Default Security Level. Issues are Public)
> Reporter: Steve Rowe
> Priority: Minor
>
> From [~dsmiley] and [~janhoy] on SOLR-10290:
> {quote}
> David: Can we auto-linewrap the asciidoc content we've imported somehow? The
> lines are super-long in my IDE (IntelliJ). I can toggle the active editor's
> "soft wrap" at least (View menu, then Active Editor menu).
> Jan: Yea, those lines are long
> {quote}
> From a conversation [~ctargett] and I had on SOLR-10379:
> {quote}
> Steve: I updated the ref guide docs. While I was at it, I installed and used
> the IntelliJ plugin named "Wrap To Column" to wrap at 120 chars (a.k.a. "fill
> paragraph") in the two .adoc files I edited.
> Cassandra: What is the point of this, or even, the big deal about asking your
> IDE to do soft wraps instead?
> Steve: Not all editors support soft-wrapping. There is project consensus to
> wrap code at 120-chars; why make an exception for these doc files?
> {quote}
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
