Skip to content

docs: correct pretty printing guide #3149

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

Open
Mr-KnightCLI wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: correct pretty printing guide #3149

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf7ef5a
docs: correct pretty printing guide
Mr-KnightCLI Oct 19, 2026
0106d40
Update UserGuide.md
Mr-KnightCLI Oct 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,9 +517,7 @@ In the above example, an instance of the Id class can not be created without act

The default JSON output that is provided by Gson is a compact JSON format. This means that there will not be any whitespace in the output JSON structure. Therefore, there will be no whitespace between field names and its value, object fields, and objects within arrays in the JSON output. As well, "null" fields will be ignored in the output (NOTE: null values will still be included in collections/arrays of objects). See the [Null Object Support](#null-object-support) section for information on configure Gson to output all null values.

If you would like to use the Pretty Print feature, you must configure your `Gson` instance using the `GsonBuilder`. The `JsonFormatter` is not exposed through our public API, so the client is unable to configure the default print settings/margins for the JSON output. For now, we only provide a default `JsonPrintFormatter` that has default line length of 80 character, 2 character indentation, and 4 character right margin.

The following is an example shows how to configure a `Gson` instance to use the default `JsonPrintFormatter` instead of the `JsonCompactFormatter`:
To use pretty printing, configure your `Gson` instance with `GsonBuilder.setPrettyPrinting()`. This uses Gson's standard pretty formatting style, with a newline between lines, two spaces for indentation, and a space after JSON separators. For a custom style, use `GsonBuilder.setFormattingStyle(FormattingStyle)`; see the [`FormattingStyle` API](https://javadoc.io/doc/com.google.code.gson/gson/latest/com.google.gson/com/google/gson/FormattingStyle.html) for the available options.

```java
Gson gson = new GsonBuilder().setPrettyPrinting().create();
Expand Down
Loading