Rustfmt: [unstable option] wrap_comments

Created on 13 Feb 2019  路  13Comments  路  Source: rust-lang/rustfmt

Tracking issue for unstable option: wrap_comments

unstable option

Most helpful comment

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

All 13 comments

What is left to stabilize this?

There is now a documented process describing stabilisation so we'd have to go through the conditions set there.

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

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)

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.

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.

Any updates on this?

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

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

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?

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.

Just filed an issue regarding the breakage of markdown tables. It looks like this was fixed at some point in the past, then we regressed.

It looks like this was fixed at some point in the past, then we regressed.

That is incorrect. There are different branches in this repository with what at this point are fairly divergent versions of rustfmt. A fix was made to the master branch, but wasn't applied (much less released) on any branches associated with current/distributed versions of rustfmt.

Going to hide these last two comments to avoid any confusion

Was this page helpful?
0 / 5 - 0 ratings