Skip to content

Add -Ycook-comments to cook comments #4574

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

Duhemm
Copy link
Contributor

@Duhemm Duhemm commented May 24, 2018

This commit adds the -Ycook-comments option that will enable cooking
of the comments (type checking of @usecase in docstrings, expansion of
@define and @inheritdoc, etc.)

There are two reasons for introducing this configuration option:

  • Cooking the comments slows the compilation down in cases where we
    are not interested in cooking them.
  • Cooking the comments breaks -Ycheck, which prevents us from
    enabling -Ykeep-comments by default.

This commit adds the `-Ycook-comments` option that will enable cooking
of the comments (type checking of `@usecase` in docstrings, expansion of
`@define` and `@inheritdoc`, etc.)

There are two reasons for introducing this configuration option:

 - Cooking the comments slows the compilation down in cases where we
   are not interested in cooking them.
 - Cooking the comments breaks `-Ycheck`, which prevents us from
   enabling `-Ykeep-comments` by default.
@allanrenucci allanrenucci merged commit a04d426 into scala:master May 28, 2018
@allanrenucci allanrenucci deleted the topic/comments-default-no-cook branch May 28, 2018 13:57
allanrenucci added a commit to dotty-staging/dotty that referenced this pull request Jul 4, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants