Skip to content
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

Document kapt inheritance of super configurations #4206

Merged
merged 1 commit into from
May 28, 2024

Conversation

sarahhaggarty
Copy link
Collaborator

This PR documents how kapt configurations can inherit annotation processors from super configurations in Kotlin 2.0.0.

@sarahhaggarty sarahhaggarty requested a review from a team as a code owner May 16, 2024 12:29
Base automatically changed from 2-0-0-doc-update to master May 21, 2024 16:02
@sarahhaggarty sarahhaggarty force-pushed the kapt-super-processing branch 2 times, most recently from b0d91ab to a531d2e Compare May 27, 2024 14:29
Copy link
Contributor

@zamulla zamulla left a comment

Choose a reason for hiding this comment

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

Looks great, I left a couple of comments that might be helpful for polish.

docs/topics/kapt.md Outdated Show resolved Hide resolved
You can define a common set of annotation processors in a separate Gradle configuration as a
super configuration and extend it further in kapt-specific configurations for your subprojects.

As an example, for a subproject using [Dagger](https://dagger.dev/), in your `build.gradle(.kts)` file, use the following configuration:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
As an example, for a subproject using [Dagger](https://dagger.dev/), in your `build.gradle(.kts)` file, use the following configuration:
As an example, for a subproject using [Dagger](https://dagger.dev/), use the following configuration in your `build.gradle(.kts)` file:

Trying to make it sound a bit smoother, tell me if I succeeded.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

During my TWr training it was drilled into me that when giving instructions, you always put the WHERE before the WHAT 😄 Is it much harder for you to read if I keep it like this?

Copy link
Contributor

Choose a reason for hiding this comment

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

It's not much harder, but I did stumble over the third comma here :) not a big deal for sure.

docs/topics/kapt.md Outdated Show resolved Hide resolved
docs/topics/kapt.md Outdated Show resolved Hide resolved
@sarahhaggarty sarahhaggarty merged commit 6749ce4 into master May 28, 2024
3 checks passed
@sarahhaggarty sarahhaggarty deleted the kapt-super-processing branch May 28, 2024 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants