doc: add documentation for new api

simschla · simschla · commit de846978cfa1 · 2024-11-28T13:04:01.000+01:00
Refs: #794, #2311
diff --git a/plugin-gradle/CHANGES.md b/plugin-gradle/CHANGES.md
@@ -3,6 +3,9 @@
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `3.27.0`).
 
 ## [Unreleased]
+### Changed
+* Clarify API for generic indentation. Deprecated `indentWithSpaces` and `indentWithTabs` in favor of `leadingTabsToSpaces` and `leadingSpacesToTabs`. ([#794](https://github.com/diffplug/spotless/issues/794), [#2350](https://github.com/diffplug/spotless/pull/2350))
+
 
 ## [7.0.0.BETA2] - 2024-08-25
 ### Changed
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 {

Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ spotless {`
`111`	`111`
`112`	`112`	`// define the steps to apply to those files`
`113`	`113`	`trimTrailingWhitespace()`
`114`		`- indentWithTabs() // or spaces. Takes an integer argument if you don't like 4`
	`114`	`+ leadingSpacesToTabs() // or leadingTabsToSpaces. Takes an integer argument if you don't like 4`
`115`	`115`	`endWithNewline()`
`116`	`116`	`}`
`117`	`117`	`java {`