Website and Guide only: Add try/finally example (closing Response) #3097
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
swankjesse
reviewed
Jan 9, 2017
| @@ -107,6 +107,33 @@ <h3 id="examples">Examples</h3> | |||
| } | |||
| </pre> | |||
|
|
|||
| <h4>Try/Finally example</h4> | |||
There was a problem hiding this comment.
I think this might be a distraction from our otherwise spartan docs. Wanna just fix the first example to use try/finally?
There was a problem hiding this comment.
I can do that. It does mean the very first example users see is ... a bit 'irk' imo. It is completely your call though ... (I'm heading home now, I'll check in later).
| /** | ||
| * Example using try/finally (typically when try with resources is not available). | ||
| */ | ||
| public class GetTryFinallyExample { |
|
Sorry for sending you in circles on this. I really want our docs to show off OkHttp’s API, and not tour the madness that is writing defensive Java code. Maybe the standalone try block is sufficient. Gross sample code is gross. |
|
Closing after a year |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note this example uses
okhttp3.internal.Util.closeQuietly()... to close potentially nullResponse. I'm not sure if you want to encourage that or not.