`wrap_comments` doesn't reflow text.
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
Another one for wrap_comments:
/// this
/// is
/// an
/// unnecessarily
/// tall
/// comment.
fn foo() {}
The formatter doesn't format these comments
While this may be desirable in some cases, (e.g. TODOs), in light of #627, perhaps a better general solution is to add a markdown formatter and use it inside doc comments, since those are necessarily Markdown, ideally independently of whether or not non-doc comments are formatted.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the wrap_comments handling for doc comments and review the context in issue #627. The issue does not name files or tests, and proposes a general Markdown formatter used inside doc comments; done would include reflowing the shown comment while considering the stated behavior for non-doc comments.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100