Keep indentation in doc comments and simplify #1082
Merged
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.
Leading spaces is significant for Markdown and we should not blindlessly trim them, which may break Markdown lists or code blocks.
Here we strip the minimal indentation of all non-empty doc comment lines, so we can both keep Markdown semantics and avoid unnecessary leading spaces immediately after the
///
token.Eg.
The
bar
line is indented and should continue the previous paragraph in the first unordered list elementfoo
. But if stripping the leading whitespaces,bar
will start a new paragraph, which is incorrect.