diff --git a/value/README.md b/value/README.md index f6c00c30a1..185969baa0 100644 --- a/value/README.md +++ b/value/README.md @@ -21,5 +21,12 @@ less code and less room for error, while **not restricting your freedom** to code almost any aspect of your class exactly the way you want it. For more information, consult the -[detailed -documentation](userguide/index.md) +[detailed documentation](userguide/index.md). + +**Note:** If you are using Kotlin then its +[data classes](https://kotlinlang.org/docs/data-classes.html) are usually more +appropriate than AutoValue. Likewise, if you are using a version of Java that +has [records](https://docs.oracle.com/en/java/javase/16/language/records.html), +then those are usually more appropriate. You can still use +[AutoBuilder](userguide/autobuilder.md) to make builders for data classes or +records. diff --git a/value/userguide/index.md b/value/userguide/index.md index 491698676a..482c7e49f7 100644 --- a/value/userguide/index.md +++ b/value/userguide/index.md @@ -31,6 +31,14 @@ AutoValue provides an easier way to create immutable value classes, with a lot less code and less room for error, while **not restricting your freedom** to code almost any aspect of your class exactly the way you want it. +**Note**: If you are using Kotlin then its +[data classes](https://kotlinlang.org/docs/data-classes.html) are usually more +appropriate than AutoValue. Likewise, if you are using a version of Java that +has [records](https://docs.oracle.com/en/java/javase/16/language/records.html), +then those are usually more appropriate. You can still use +[AutoBuilder](userguide/autobuilder.md)--> to make builders for data classes or +records. + This page will walk you through how to use AutoValue. Looking for a little more persuasion? Please see [Why AutoValue?](why.md). @@ -279,4 +287,4 @@ How do I... * ... [create a **pretty string** representation?](howto.md#toprettystring) - +