rust-lang / rust-lang/mdBook

Unclosed HTML tag warning should mention line numbers

Open
#3,079 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-enhancement
Dominant language
Rust
Stars
22.2k
Forks
1.9k
PR merge metrics
PR metrics pending

Description

Problem

Why do I need to copy and paste the tag itself and search in order to find and fix it?

 WARN unclosed HTML tag `<tag>` found in `markdown.md` while exiting Paragraph
HTML tags must be closed before exiting a markdown element.
Proposed Solution

Wouldn't it be nice if the warning mentions the line number itself of the unclosed opening tag and where the Markdown element exited?

Notes

As of v0.5.2.

Contributor guide

Open the contributing guide

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 warning that reports an unclosed HTML tag while exiting a Markdown element. Trace how the opening tag and Markdown exit locations are tracked, then update the warning to include both line numbers. Done means the warning identifies the line of the unclosed opening tag and the line where the Markdown element exited.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
56/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.