doc: add documentation for new api

Refs: diffplug#794, diffplug#2311
simschla · Nov 27, 2024 · 71f6559 · 71f6559
1 parent a7d9ee7
commit 71f6559
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/plugin-gradle/CHANGES.md b/plugin-gradle/CHANGES.md
@@ -16,6 +16,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 * Bump default `gson` version to latest `2.10.1` -> `2.11.0`. ([#2128](https://github.com/diffplug/spotless/pull/2128))
 * Bump default `cleanthat` version to latest `2.20` -> `2.21`. ([#2210](https://github.com/diffplug/spotless/pull/2210))
 * Bump default `google-java-format` version to latest `1.22.0` -> `1.23.0`. ([#2212](https://github.com/diffplug/spotless/pull/2212))
+* Clarify api for generic indentation. Deprecated `indentWithSpaces` and `indentWithTabs` in favor of `leadingTabsToSpaces` and `leadingSpacesToTabs`. ([#794](https://github.com/diffplug/spotless/issues/794), [#2346](https://github.com/diffplug/spotless/pull/2346))
 ### Fixed
 * Fix compatibility issue introduced by `ktfmt` `0.51`. ([#2172](https://github.com/diffplug/spotless/issues/2172))
 ### Added

diff --git a/plugin-gradle/README.md b/plugin-gradle/README.md
@@ -111,7 +111,7 @@ spotless {
 
     // define the steps to apply to those files
     trimTrailingWhitespace()
-    indentWithTabs() // or spaces. Takes an integer argument if you don't like 4
+    leadingSpacesToTabs() // or leadingTabsToSpaces. Takes an integer argument if you don't like 4
     endWithNewline()
   }
   java {