Skip to content

Commit

Permalink
Add javadoc to Subsegment.close() method.
Browse files Browse the repository at this point in the history
This method should not be used to end subsegments for segments using multiple threads as this can result in a deadlock. See #318 for details.
  • Loading branch information
Kurru committed Jul 27, 2022
1 parent 6f25e12 commit 08b44f1
Showing 1 changed file with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ static Subsegment noOp(Segment parent, AWSXRayRecorder recorder) {
/**
* Serializes the subsegment as a standalone String with enough information for the subsegment to be streamed on its own.
* @return
* the string representation of the subsegment with enouogh information for it to be streamed
* the string representation of the subsegment with enough information for it to be streamed
*/
String streamSerialize();

Expand All @@ -96,7 +96,7 @@ static Subsegment noOp(Segment parent, AWSXRayRecorder recorder) {
* own. Only used for debugging.
*
* @return
* the pretty string representation of the subsegment with enouogh information for it to be streamed
* the pretty string representation of the subsegment with enough information for it to be streamed
*/
String prettyStreamSerialize();

Expand Down

0 comments on commit 08b44f1

Please sign in to comment.