Skip to content

docs(research): wrapped line begins with an issue number, read as a malformed heading #13055

Closed

Description

@mrveiss

Problem

In docs/research/lean-hardware-model-loading.md, the §2 opening paragraph names five originating
issues in sequence. The prose wraps such that a line begins with #1946, which markdownlint reads as
a malformed ATX heading (MD018 — no space after hash).

GitHub renders the line as plain text either way, since CommonMark requires a space after # for a
heading, so nothing is visually wrong. The warning is still real, and it recurs on every edit to that
paragraph because with five numbers in sequence any wrap point places one at a line start.

History

PR #13040 (which introduced the document) contained a commit claiming to fix this. That commit only
changed which issue number led the line — the defect survived. Filing this discretely so the fix is
tracked against something other than the umbrella it was discovered in.

Fix

Restructure the sentence so the continuation line begins with a word: move the issue list to the end
of the sentence and reflow.

Acceptance

grep -c '^#[0-9]' docs/research/lean-hardware-model-loading.md   # → 0
grep -c '^## '    docs/research/lean-hardware-model-loading.md   # → 5 (headings intact)

Related

Activity

  1. github-actions commented on Jul 30, 2026

    @github-actions
    Contributor

    PR #13056 (merged to Dev_new_gui) references this issue with a close keyword.

    docs(research): stop a wrapped line beginning with an issue number (#13055)

    If this issue is fully resolved, close it manually. If work remains, no action is needed.

  2. mrveiss commented on Jul 30, 2026

    @mrveiss
    OwnerAuthor

    Fixed and merged to Dev_new_gui. Closing manually — Closes #N only fires on the default branch, so a base-branch merge does not auto-close.

    Evidence

    Acceptance criteria verified against the merged file on Dev_new_gui:

    $ git show origin/Dev_new_gui:docs/research/lean-hardware-model-loading.md | grep -c '^#[0-9]'
    0        # was 1
    
    $ git show origin/Dev_new_gui:docs/research/lean-hardware-model-loading.md | grep -c '^## '
    5        # headings intact
    
    $ git show origin/Dev_new_gui:docs/research/lean-hardware-model-loading.md | grep -c '^# '
    1
    

    The §2 sentence now places the issue list at the end so the wrapped line begins with a word, which is stable against future edits to that paragraph in a way the #13040 attempt was not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions