docs: improve scaladocs for TastyFormat #14192
Merged
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
smarter
reviewed
Dec 30, 2021
The main motivation behind this is to improve the reader experience when looking at the TastyFormat docs on https://scala-lang.org/api/3.x/dotty/tools/tasty/TastyFormat$.html since in its current format all spacing is lost. This instead utilizes code blocks in a valid scaladoc to ensure the spacing is kept. You can see what this should look like by looking at https://scala-lang.org/api/3.x/scala/quoted/Quotes$reflectModule.html which uses the same approach. Addresses lampepfl/dotty-feature-requests#273
ckipp01
force-pushed
the
TastyFormatDoc
branch
from
3ea5cf5 to
011d553
Compare
smarter
approved these changes
Dec 31, 2021
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 main motivation behind this is to improve the reader experience when
looking at the TastyFormat docs on
https://scala-lang.org/api/3.x/dotty/tools/tasty/TastyFormat$.html since
in its current format all spacing is lost. This instead utilizes code
blocks in a valid scaladoc to ensure the spacing is kept. You can see
what this should look like by looking at
https://scala-lang.org/api/3.x/scala/quoted/Quotes$reflectModule.html
which uses the same approach.
Addresses lampepfl/dotty-feature-requests#273