Skip to content

Conversation

@nicolasstucki
Copy link
Contributor

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

@nicolasstucki nicolasstucki self-assigned this Sep 23, 2020
@nicolasstucki nicolasstucki force-pushed the rename-Reflection-Comment-to-Documentation branch from f2bff03 to 513d391 Compare September 24, 2020 07:21
@nicolasstucki
Copy link
Contributor Author

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.

@nicolasstucki
Copy link
Contributor Author

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 nicolasstucki force-pushed the rename-Reflection-Comment-to-Documentation branch from 513d391 to c291a96 Compare September 24, 2020 14:13
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 nicolasstucki force-pushed the rename-Reflection-Comment-to-Documentation branch from c291a96 to 9207fd3 Compare September 25, 2020 11:56
@nicolasstucki nicolasstucki marked this pull request as ready for review September 28, 2020 07:21
Copy link
Contributor

@abgruszecki abgruszecki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@abgruszecki abgruszecki merged commit 1e63423 into scala:master Sep 29, 2020
@abgruszecki abgruszecki deleted the rename-Reflection-Comment-to-Documentation branch September 29, 2020 09:32
@Kordyjan Kordyjan added this to the 3.0.0 milestone Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants