Add javadoc to Subsegment.close() method. - #342
Merged
Conversation
Codecov Report
@@ Coverage Diff @@
## master #342 +/- ##
============================================
- Coverage 58.96% 58.95% -0.02%
Complexity 1207 1207
============================================
Files 131 131
Lines 5064 5065 +1
Branches 592 592
============================================
Hits 2986 2986
- Misses 1805 1806 +1
Partials 273 273
Continue to review full report at Codecov.
|
Kurru
force-pushed
the
subsegment-close-doc
branch
2 times, most recently
from
July 27, 2022 00:16
08b44f1 to
00a0723
Compare
Member
|
Hi @Kurru, could you change your javadoc as the .close() method is not designed for external use and should not be used externally in general, rather than for a specific use case? |
Kurru
force-pushed
the
subsegment-close-doc
branch
2 times, most recently
from
July 27, 2022 23:50
402fefd to
31147a9
Compare
Contributor
Author
|
I have updated the javadoc as requested. Let me know if this new wording is insufficient. |
jj22ee
reviewed
Jul 28, 2022
This method should not be used to end subsegments for segments using multiple threads as this can result in a deadlock. See aws#318 for details.
Kurru
force-pushed
the
subsegment-close-doc
branch
from
July 28, 2022 00:09
31147a9 to
ba7a37b
Compare
jj22ee
approved these changes
Jul 28, 2022
This file contains hidden or 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
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.
Issue #, if available:
#318
Description of changes:
Add javadoc to Subsegment.close() method.
This method should not be used to end subsegments for segments using multiple threads as this can result in a deadlock.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.