New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Surface @SerialName annotation in top-level documentation #2468

Open

reddaly opened this issue Oct 11, 2023 · 0 comments

Labels

feature

reddaly commented Oct 11, 2023

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 added the feature label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment