kotlinx.serialization icon indicating copy to clipboard operation
kotlinx.serialization copied to clipboard

Surface @SerialName annotation in top-level documentation

Open reddaly opened this issue 2 years ago • 0 comments

What is your use-case and why do you need this feature?

The @SerialName is a bit buried in the documentation

It took a few minutes for me to find that.

Describe the solution you'd like

Update the top-level README to contain an example of a custom field name, like so:

@Serializable
class Project(val name: String, @SerialName("lang") val language: String)

reddaly avatar Oct 11 '23 00:10 reddaly