uabrc / uabrc/uabrc.github.io

Add avoiding Lazy Continuation Lines to the Contributor Guide

Open
#867 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

dev: style 🛠️🖋️
Dominant language
Python
Stars
24
Forks
15
Avg merge
10d 3h
Merged PRs (30d)
1

Description

On the subject of "Lazy Continuation Lines". They are not strictly against the specification of Markdown, and so are not (yet) caught by Markdown Lint nor by the automatic formatter. There is an issue to add an optional rule for this to Markdown Lint: https://github.com/DavidAnson/markdownlint/issues/977

Here is what it looks like:

this is a lazy continuation line and will be part of the previous line
  so will this
                   so will this

- this is an unordered list item
lazy continuation line
  and this
                 and this

lists aren't
  required
for this```

Each of the examples above have all of the text rendered into continuous paragraphs, like below.

```1. this is an ordered list item this is a lazy continuation line and will be part of the previous line so will this so will this

- this is an unordered list item lazy continuation line and this and this

lists aren't required for this```

Do not use lazy continuation lines as they create hard-to-maintain inconsistencies in the documentation and appear ambiguous in terms of writer intent. Based on your intent, either explicitly connect the lazy continuation to the previous item by removing the newline, or explicitly include a blank line between the list item and the continuation line.

Using the ordered list example, one or the other of the two options below.

```1. this is an ordered list item this is a lazy continuation line and will be part of the previous line so will this so will this

1. this is an ordered list item

    this is a lazy continuation line and will be part of the previous line
 
    so will this
    
    so will this```

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Contributor Guide in the repository and read its existing Markdown guidance. Add the issue's explanation and examples of avoiding lazy continuation lines, then review the rendered documentation to confirm the guidance is clear and correctly formatted.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.