tree: document sorted nature of random trees #1467
Open
+1 −1
Conversation
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
For the use that the tour makes of "golang.org/x/tour/tree" it is important that the generated trees are sorted. While New() does generate sorted trees it is current documented as "returns a new, random binary tree" and many readers will assume "random" implies "non-sorted". Update doc that trees are "randomly-structured, sorted" to clarify what is random and that trees are sorted.
| This PR (HEAD: 7c6a425) has been imported to Gerrit for code review. Please visit https://go-review.googlesource.com/c/tour/+/478315 to see it. Tip: You can toggle comments from me using the |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
For the use that the tour makes of "golang.org/x/tour/tree" it is important that the generated trees are sorted. While New() does generate sorted trees it is current documented as "returns a new, random binary tree" and many readers will assume "random" implies "non-sorted".
Update doc that trees are "randomly-structured, sorted" to clarify what is random and that trees are sorted.