Skip to content
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.

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

Improve documentation about default JsonReader and JsonWriter behavior #2341

Merged

Conversation

Marcono1234
Copy link
Collaborator

@Marcono1234 Marcono1234 commented Mar 13, 2023

Purpose

Tries to improve the documentation about default JsonReader and JsonWriter behavior, and related TypeAdapter methods

Description

The current default behavior was not explicitly mentioned; also for the TypeAdapter methods it was not clear that their behavior differs from the default Gson behavior, see also #1133.

Also removes some empty lines at the start of <pre> blocks in the documentation (they also appeared in the rendered HTML).

Checklist

  • New code follows the Google Java Style Guide
  • If necessary, new public API validates arguments, for example rejects null
  • New public API has Javadoc
    • Javadoc uses @since $next-version$
      ($next-version$ is a special placeholder which is automatically replaced during release)
  • If necessary, new unit tests have been added
    • Assertions in unit tests use Truth, see existing tests
    • No JUnit 3 features are used (such as extending class TestCase)
    • If this pull request fixes a bug, a new test was added for a situation which failed previously and is now fixed
  • mvn clean verify javadoc:jar passes without errors

@Marcono1234 Marcono1234 changed the title Improve documentation about default JsonWriter behavior Improve documentation about default JsonReader and JsonWriter behavior Aug 4, 2023
@eamonnmcmanus eamonnmcmanus merged commit f72824e into google:main Aug 5, 2023
8 checks passed
@Marcono1234 Marcono1234 deleted the marcono1234/JsonWriter-config-doc branch August 6, 2023 23:04
tibor-universe pushed a commit to getuniverse/gson that referenced this pull request Sep 14, 2024
…avior (google#2341)

* Improve documentation about default `JsonWriter` behavior

* Revert accidental formatting change

* Document default JsonReader configuration & improve doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants