Add doc_comment_code_block_small_heuristics, to override use_small_heuristics in doc code
#6616
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This allows overriding `use_small_heuristics` in doc code. This is particularly useful for code that wants to use `use_small_heuristics = "Max"` internally but present doctests and examples using `use_small_heuristics = "Default"`.
This test is based on the `use_small_heuristics` tests. It tests that the code *outside* the doc comment gets formatted using `Max`, while the code inside doc comments gets formatted using `Default`.
joshtriplett
force-pushed
the
doc-comment-use-small-heuristics
branch
from
190fe00 to
a0dc042
Compare
|
is doc_comment_code_block_width not enough to override the width settings when formatting code blocks? |
|
@ytmimi No, because if you're using |
|
It wasn't originally clear to me but now I understand. You want a way to override all width settings when formatting code blocks in doc comments. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This (unstable) configuration option allows overriding
use_small_heuristicsfor doc code. This is particularly useful for code that wants to useuse_small_heuristics = "Max"internally but present doctests and examples usinguse_small_heuristics = "Default".This has come up before in the context of formatting the standard library, which uses
use_small_heuristics = "Max"internally, but wants to present documentation and examples in the style most people will normally see.