[ 
https://issues.apache.org/jira/browse/SOLR-10749?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16031506#comment-16031506
 ] 

Jason Gerlowski commented on SOLR-10749:
----------------------------------------

Another point that I haven't heard yet is how enforcing a line length would 
affect diff/patch readability.

Imagine an *.adoc paragraph of 10 source lines, each close to the line length.  
Adding a phrase in the second line will
cause a cascade of words onto all the subsequent lines in the paragraph.  A 
diff will show 8 lines changed.  This is noisy, and might make actual changes 
in substance/content hard to pick out.

Some diff viewers/editors might mitigate this somewhat.  So take it for what 
it's worth.  Just wanted to mention it as I hadn't heard anyone mention it yet.

> 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]

Reply via email to