Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-10290 New Publication Model for Solr Reference Guide
  3. SOLR-10749

Should ref guide asciidoc files' line length be limited?

    XMLWordPrintableJSON

Details

    • Sub-task
    • Status: Resolved
    • Minor
    • Resolution: Won't Fix
    • None
    • None
    • None
    • None

    Description

      From dsmiley and janhoy on SOLR-10290:

      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

      From a conversation ctargett and I had on SOLR-10379:

      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?

      Attachments

        Activity

          People

            sarowe Steven Rowe
            sarowe Steven Rowe
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: