fix: don't add extra newlines when there aren't extra sections in doc markdown #14734
Conversation
This file contains 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
michelou
reviewed
Mar 21, 2022
There was a problem hiding this comment.
@ckipp01 I suggest the following change to lines 68ff :
if sections.nonEmpty then
buf.append(System.lineSeparator + System.lineSeparator)
sections.foreach { section =>
buf.append(section)
buf.append(System.lineSeparator)
}
buf.toString
… markdown Currently if you have a simple scaladoc and you use `renderAsMarkdown` (which Metals does) to render markdown for hovers, there are extra newlines added that aren't necessary. Normally you can't tell as it seems some editors just trim off the extra newlines, but you can see in certain editors and in the REPL as well. _Notice how it removes two lines_ ```diff scala> :doc CanEqual Companion object containing a few universally known `CanEqual` instances. CanEqual instances involving primitive types or the Null type are handled directly in the compiler (see Implicits.synthesizedCanEqual), so they are not included here. - - ``` This just ensures that we add the extra two newlines only when we know we have more sections coming. fixes scalameta/metals#3740
ckipp01
force-pushed
the
docCommentMarkdown
branch
from
61c235c
to
310a90b
Compare
Ah, good idea. Applied. |
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.
Currently if you have a simple scaladoc and you use
renderAsMarkdown(which Metals does) to render markdown for hovers, there are extra
newlines added that aren't necessary. Normally you can't tell as it
seems some editors just trim off the extra newlines, but you can see
in certain editors and in the REPL as well.
Notice how it removes two lines
This just ensures that we add the extra two newlines only when we know
we have more sections coming.
fixes scalameta/metals#3740