docs: improve msatCeilOf/msatFloorOf kdoc

ovitrif · claude · ovitrif · commit d6ccbe738a52 · 2026-04-06T00:45:32.000+02:00
Co-Authored-By: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;
diff --git a/app/src/main/java/to/bitkit/models/MSat.kt b/app/src/main/java/to/bitkit/models/MSat.kt
@@ -19,8 +19,8 @@ value class MSat(val value: ULong) {
     fun floor(): ULong = value / PER_SAT
 }
 
-/** Syntactic sugar for [MSat.ceil]. */
+/** Round [msat] up to the nearest whole sat. Use for payment/display amounts. */
 fun msatCeilOf(msat: ULong): ULong = MSat(msat).ceil()
 
-/** Syntactic sugar for [MSat.floor]. */
+/** Truncate sub-sat remainder from [msat]. Use for fees and upper bounds. */
 fun msatFloorOf(msat: ULong): ULong = MSat(msat).floor()

Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@ value class MSat(val value: ULong) {`
`19`	`19`	`fun floor(): ULong = value / PER_SAT`
`20`	`20`	`}`
`21`	`21`
`22`		`-/** Syntactic sugar for [MSat.ceil]. */`
	`22`	`+/** Round [msat] up to the nearest whole sat. Use for payment/display amounts. */`
`23`	`23`	`fun msatCeilOf(msat: ULong): ULong = MSat(msat).ceil()`
`24`	`24`
`25`		`-/** Syntactic sugar for [MSat.floor]. */`
	`25`	`+/** Truncate sub-sat remainder from [msat]. Use for fees and upper bounds. */`
`26`	`26`	`fun msatFloorOf(msat: ULong): ULong = MSat(msat).floor()`