Clarify in documentation that Gson might cache strategy results #2215
Conversation
eamonnmcmanus
left a comment
eamonnmcmanus
left a comment
There was a problem hiding this comment.
Seems good. Just one tiny comment (which applies several times).
| * Configures Gson to apply a specific naming strategy to an object's fields during | ||
| * serialization and deserialization. | ||
| * | ||
| * <p>The Gson instance might only use the field naming strategy once for a field and |
There was a problem hiding this comment.
I think I would use {@link Gson} here to make it clear that we are talking about the class here (in the previous paragraph we are talking about Gson the project).
There was a problem hiding this comment.
I had a similar concern, being afraid that users might think Gson statically (for all Gson instances) caches the results. That is why I chose "Gson instance", but I have now changed it to "The created Gson instance". In the context of this builder I hope this should be clear enough.
In this specific line where you added the comment I don't think a {@link Gson} would be needed. The previous paragraph is also about the Gson instance and not about specifying a naming strategy globally. Or did I misunderstand you?
There was a problem hiding this comment.
This is fine now. I would probably use {@link} or {@code} every time we're talking about Gson the class, since Gson is also the name of the project. But that's probably overly fussy.
2 participants
Resolves #2205
Maybe it could also be considered whether that behavior could be customized in the future, but for now it might suffice to document it.
Feedback, especially regarding the wording, is appreciated!