Uploaded image for project: 'TinkerPop'
  1. TinkerPop
  2. TINKERPOP-908

Use line breaks in documentation

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Major
    • Resolution: Implemented
    • 3.0.2-incubating
    • 3.1.0-incubating
    • documentation
    • None

    Description

      It wasn't realized early on that asciidoc would respect line breaks (as being a single paragraph) in documentation so we tended to rely on intellij for artificial line breaks. The problem with that approach was that if a single letter changed in the docs within a paragraph it wasn't easy to see in a git diff what the change was because the whole line would be seen as a diff. This also made merging docs more difficult.

      Attachments

        Activity

          People

            spmallette Stephen Mallette
            spmallette Stephen Mallette
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: