Skip to content

Rename -Y{cook|drop}-comments to -Y{cook|drop}-docs #12439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

nicolasstucki
Copy link
Contributor

These operate on documentation strings, not comments.

A comment is never cooked and always droped

// comment

Documentation can be cooked and may be dropped if not needed

/** documentation */

These operate on documentation strings, not comments.

A comment is never cooked and always droped
```scala
// comment
```

Documentation can be cooked and may be dropped if not needed

```scala
/** documentation */
```
@nicolasstucki nicolasstucki requested a review from abgruszecki May 12, 2021 11:37
@nicolasstucki nicolasstucki marked this pull request as ready for review May 12, 2021 16:09
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. I grepped for those and can't find any usage in the codebase.

@abgruszecki abgruszecki merged commit 5e27be2 into scala:master May 13, 2021
@abgruszecki abgruszecki deleted the fix-compiler-falgs-for-documentation branch May 13, 2021 13:58
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.

2 participants