XMLWordPrintable

    Details

    • Type: Bug
    • Status: New
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: TOSCA Simple Profile in YAML Version 1.0
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None
    • Environment:

      Style

    • Proposal:
      Hide

      Do your readers a favor and remove hanging paragraphs, all sections and subsections.

      Show
      Do your readers a favor and remove hanging paragraphs, all sections and subsections.

      Description

      I am hard pressed to explain why hanging paragraphs are avoided sometimes but not others. Compare and contrast: 5.8, 7.4, 7.5, and 7.6 (no hanging paragraphs) to 5.9 and 8.0 (with hanging paragraphs).

      Using 8.0 as an example:

      *****
      8 Non-normative type definitions

      This section defines non-normative types used in examples or use cases within this specification.

      8.1 Artifact Types
      *****

      How do I cite the paragraph immediately following 8 Non-normative type definitions?

      If I say, see Section 8 Non-normative type definitions, doesn't that mean all of section 8? How is a reader going to know when I mean the first paragraph of that section and not the entire section?

      When you have a section or subsection with further sub-divisions, text should not occur after the section or sub-section header. Insert a sub-division to hold that paragraph. Then you can easily cite any portion of the document.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              patrick Patrick Durusau
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: