[unstable option]: doc_comment_code_block_width

[calebcartwright]

Tracking issue for unstable option: doc_comment_code_block_width.

Option documentation.

See Processes.md, "Stabilising an Option":

• Is the default value correct?
• The design and implementation of the option are sound and clean.
• The option is well tested, both in unit tests and, optimally, in real usage.
• There is no open bug about the option that prevents its use.

Also see:

• Configuration Option Stabilization
• How can I help get a config option stabilized?

[tgross35]

From another issue:

This probably brings up a larger question about whether doc_comment_code_block_width should have a default of 100, since in the best case there will only ever be 96 characters ( or more generally max_width minus /// characters).

My 2¢ is that if unspecified, doc_comment_code_block_width should use max_width, meaning max_width - 4 characters in the doc comment. I think it currently defaults to 100, but am unsure if it changes with max_width.

Better imho to have it end at the same line length as the main content than to go 4 characters over (doc_comment_code_block_width = 104 by default) so users don't wind up with horizontal scrolling if their editors are set up for 100. That is the current behavior, just affirming