[unstable option] wrap_comments #3347

Activity

1. scampi

   added

   unstable-optionTracking issue of an unstable optionTracking issue of an unstable option

   on Feb 13, 2019
2. scampi

   changed the title [-][unstable option] unstable option: wrap_comments[/-] [+][unstable option] wrap_comments[/+] on Feb 18, 2019
3. carllerche commented on May 10, 2019

   

   carllerche

   on May 10, 2019

   More actions

   What is left to stabilize this?
4. scampi commented on May 16, 2019

   

   scampi

   on May 16, 2019

   ContributorAuthor

   More actions

   There is now a documented process describing stabilisation so we'd have to go through the conditions set there.
5. benbrittain commented on Oct 28, 2019

   

   benbrittain

   on Oct 28, 2019

   Contributor

   More actions

   Is there a link to the stabilization process? I can't find it from the README.

   I'd like to see us go through this process for the wrap_comments feature

   👍React with 👍5Reacted by Marcel Guzik, porkbrain, Tianyi Shi, Bryan Hitchcock and Christian Heussy
6. calebcartwright commented on Oct 28, 2019

   

   calebcartwright

   on Oct 28, 2019

   Last edited by calebcartwright

   Member

   More actions

   The process for stabilizing options is defined in https://github.com/rust-lang/rustfmt/blob/master/Processes.md

   @scampi & @topecongiro - correct me if I'm wrong but my understanding is that the current focus is on rustfmt 2.0, and that stabilization of some of these currently-unstable config options won't come til after the 2.0 release (based on https://github.com/rust-lang/rustfmt/projects/2)
7. jhpratt commented on Oct 31, 2020

   

   jhpratt

   on Oct 31, 2020

   Member

   More actions

   FWIW while I'd like to see this stabilized, this option can also break markdown. Last time I tried, a large markdown table I had was wrapped, which meant it was no longer valid markdown.

   👍React with 👍5Reacted by James Martindale, Max, Amelia Clarke, Jacob Birkett and Bryan Hitchcock
8. bitdivine commented on Nov 9, 2020

   

   bitdivine

   on Nov 9, 2020

   More actions

   Is there a way of saying "Do not wrap this comment"? We have a similar problem with long maths formulae. It's not a blocker, it just takes a bit of effort to fix up the formulae afterwards, however it would be nice if we could make exceptions for some blocks of text. I suppose the markdown could be checked programatically before and after each conversion and the formatting could be skipped if the markdown is broken. That won't catch the formulae but it might help in your case @jhpratt . Maybe there is a nice markdown formatter out there in the wild that understands when it is looking at a table.

   👍React with 👍3Reacted by Amelia Clarke, Max and Nathan Collins
9. daniel5151 commented on Dec 7, 2020

   

   daniel5151

   on Dec 7, 2020

   More actions

   Any updates on this?
10. jhpratt commented on Dec 7, 2020

    

    jhpratt

    on Dec 7, 2020

    Member

    More actions

    @daniel5151 Updates are posted as they come in. What you see in this thread is the current status.

    👍React with 👍5Reacted by Daniel Prilik, Amelia Clarke, Luna Razzaghipour, Caleb Heuer and Mads Marquart
11. Nemo157 commented on Dec 16, 2020

    

    Nemo157

    on Dec 16, 2020

    Contributor

    More actions

    Would it be plausible to split this into wrap_comments and wrap_doc_comments, and make wrap_doc_comments markdown aware?

    👍React with 👍8Reacted by Luna Razzaghipour, Daniel Prilik, Amelia Clarke, Kevin Reid, Entropy Lost, Bryan Hitchcock, Luxalpa and convergentist
12. calebcartwright commented on Dec 17, 2020

    

    calebcartwright

    on Dec 17, 2020

    Member

    More actions

    Would it be plausible to split this into wrap_comments and wrap_doc_comments, and make wrap_doc_comments markdown aware?

    Could you elaborate a bit on the motivation? Is it just about wanting wrap_comments stabilized more quickly or are there cases where you'd want to wrap doc comments but not other comments or vice versa?

    👍React with 👍1Reacted by Amelia Clarke
13. Nemo157 commented on Dec 17, 2020

    

    Nemo157

    on Dec 17, 2020

    Contributor

    More actions

    I actually don't care about normal comments much, I want to be able to have rustfmt wrap my doc comments. My thought was that normal comments aren't required to be markdown, so it would make sense to split the implementation.

    👍React with 👍3Reacted by Luna Razzaghipour, Amelia Clarke and Frank Steffahn
14. jhpratt commented on Dec 21, 2020

    

    jhpratt

    on Dec 21, 2020 · Hidden as resolved

    show commentMore actions
15. calebcartwright commented on Dec 21, 2020

    

    calebcartwright

    on Dec 21, 2020 · Hidden as resolved

    show commentMore actions
16. 24 remaining items

    Load more
17. jieyouxu

    added sub-issues on Mar 2, 2026

    • wrap_comments=true can add a space to already properly formatted comments #6569
    • Wrapping long trailing comments #6726
18. honestlysamuk commented on Jul 10, 2026

    

    honestlysamuk

    on Jul 10, 2026

    More actions

    I found a bug using this feature flag where it involved comment blocks. There were occasions where I had something like

    // a really long comment that goes over my comment_width value immediately followed by a code block
    // ```
    // some code
    // ```
    
    

    which then transformed to

    // a really long comment that goes over my comment_width value
    // immediately followed by a code block```
    // some code
    // ```
    

    I think that this is the markdown aware part of the doc comment above. Clippy then lints our docs and warns on this.

    👍React with 👍1Reacted by Daniel Parks
19. ytmimi

    added sub-issues on Oct 6, 2026

    • Maybe don't wrap HTML in comments #4931
    • wrap_comments can break up code snippets #5250
    • inconsistent behavior of wrap_comments (merges short lines in lists) #5836
    • Regression with wrap_comments=true #5862
    • Doc comments on use declarations are limited to 5 characters less than max_width #5914
20. ytmimi

    added a related issue on Oct 6, 2026

    • normalize_doc_attributes + wrap_comments can leave trailing whitespace #7069
21. ytmimi

    added a sub-issue on Oct 6, 2026

    • Extra blank line inserted before code blocks in doc comments #6695
22. jieyouxu

    added sub-issues on Oct 12, 2026

    • rustfmt gives legal length comments a ragged edge in argument lists #7167
    • wrap_comments splits inside a link destination containing @ or /, breaking the link #7177
23. JanDiederich commented on Oct 24, 2026

    

    JanDiederich

    on Oct 24, 2026 · Hidden as off-topic

    show commentMore actions
24. ytmimi commented on Oct 24, 2026

    

    ytmimi

    on Oct 24, 2026 · Hidden as off-topic

    show commentMore actions
25. rust-lang

    locked and limited conversation to collaborators on Oct 24, 2026