Open
Conversation
54c1555 to
7691397
Compare
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
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.
The only significant change is in
.scalafmt.conf:After that,
sbt prePRwas applied.Some manual fixes in Scaladoc were also necessary – not because Scalafmt "broke" something, but because a few existing Scaladocs were incorrectly formatted and were therefore treated as plain text. For example:
Details
A table defined in plain text like that:
had to be manually converted into Markdown:
which is correctly interpreted by both Scaladoc and Scalafmt. Otherwise, it turns into a mess.
Why this change?
Two reasons:
Why this particular style?
docstrings.style = Asteriskaligns best with the majority of existing Scaladocs in the repository.