Rename reflection comment to documentation #9858
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
nicolasstucki
force-pushed
the
rename-Reflection-Comment-to-Documentation
branch
from
f2bff03 to
513d391
Compare
|
We still use the wrong name internally in the compiler, which we could later change if we want. The important part is to have ha clear user-facing API. |
|
In case the distinction between a comment and documentation is not clear /* this is comment */
/** this is documentation */
def foo: Unit =
// this is a comment
() |
nicolasstucki
force-pushed
the
rename-Reflection-Comment-to-Documentation
branch
from
513d391 to
c291a96
Compare
The name of the concept does not suggest that these are the documentation string. It also suggests that the comments can be accessed which is not the case.
nicolasstucki
force-pushed
the
rename-Reflection-Comment-to-Documentation
branch
from
c291a96 to
9207fd3
Compare
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 name of the concept does not suggest that these are the documentation string.
It also suggests that the comments can be accessed which is not the case.
Based on #9818