From ccbbac12c6ed02a1d2c1ce14a620ed764eaa96d9 Mon Sep 17 00:00:00 2001 From: Jolan Rensen Date: Wed, 21 Jan 2026 13:33:06 +0100 Subject: [PATCH] Expanded README of :plugins:public-api-modifier to explain we don't actually use this plugin (yet) --- plugins/public-api-modifier/README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/plugins/public-api-modifier/README.md b/plugins/public-api-modifier/README.md index f29219fa3e..53560377e8 100644 --- a/plugins/public-api-modifier/README.md +++ b/plugins/public-api-modifier/README.md @@ -1,4 +1,10 @@ ## :plugins:public-api-modifier -This plugin makes annotated functions internal. -Helps to produce two artifacts from the same code: one with full API, one with reduced API. +This compiler plugin makes `@AccessApiOverload` annotated functions internal. +It could help to produce two artifacts from the same code: one with the full API, one with a reduced API. + +This is an exploratory plugin that is NOT actually enabled. +See https://github.com/Kotlin/dataframe/pull/959 for more information. + +You can test it by adding `compilerPluginClasspath(projects.pluginApiModifier)` in +[`:core`](../../core/build.gradle.kts).