rust-lang / rust-lang/rustfmt

Maybe don't wrap HTML in comments

Open
#4,931 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-feature-request only-with-option P-low
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
2d 13h
Merged PRs (30d)
24

Description

I'd rather rustfmt ignored HTML when considering wraping of comments.

-//! <div style="border-left:#bda000aa 5px solid; padding:0.5em 1em; margin:1em 0 0.6em 0; background-color:#aaa2">
-//! <h3 style="color:#bfa800; margin-top:0.2em">
+//! <div style="border-left:#bda000aa 5px solid; padding:0.5em 1em; margin:1em 0 0.6em 0;
+//! background-color:#aaa2"> <h3 style="color:#bfa800; margin-top:0.2em">

Version string: rustfmt 1.4.37-stable (a178d03 2021-07-26)
Project: https://github.com/jnqnfe/pulse-binding-rust
Specific file: https://github.com/jnqnfe/pulse-binding-rust/blob/master/pulse-binding/src/lib.rs
Ran against the master branch.

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

Reproduce the behavior with rustfmt 1.4.37-stable using pulse-binding/src/lib.rs from the linked project. Start by examining how rustfmt wraps the HTML in the //! comments; done means the HTML remains unwrapped when rustfmt formats those comments.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.