Improve doc comments. #100
Merged
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
goderbauer
approved these changes
Jul 21, 2023
| @@ -45,8 +45,13 @@ class MemoryLeaksDetectedError extends StateError { | |||
| /// to wait infinitely for the forced garbage collection, that is needed | |||
| /// to analyse results. | |||
| /// | |||
| /// [gcCountBuffer] is number of full GC cycles, enough for a non reachable object to be GCed. | |||
| /// | |||
| /// [gcCountBuffer] is number of full GC cycles, that should be enough for | |||
There was a problem hiding this comment.
Thanks for the explanation! I guess, I am still confused by what the "Buffer" in the name is supposed to mean. Would this be more appropriately named "gcCycleCount" of "numberOfGcCycles"?
There was a problem hiding this comment.
good point. Will rename. It will be breaking change, but it is ok while leak tracker is work in progress.
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.
No description provided.