docs(data-structures): bring RedBlackTree docs in line with its siblings - #7313
Open
tomas-zijdemans wants to merge 2 commits into
Open
docs(data-structures): bring RedBlackTree docs in line with its siblings#7313tomas-zijdemans wants to merge 2 commits into
tomas-zijdemans wants to merge 2 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7313 +/- ##
=======================================
Coverage 95.03% 95.03%
=======================================
Files 617 617
Lines 51637 51637
Branches 9359 9359
=======================================
Hits 49075 49075
Misses 2021 2021
Partials 541 541 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Updates RedBlackTree's documentation to explain comparator uniqueness, iteration order, and the cost of its public operations. Docs and comments only.
The class documentation replaces the AVL recommendation with a comparison against BinarySearchTree, which can degrade to linear time on ordered input. Its complexity table now covers 16 operations and properties, including inherited traversals. Bounds describe full traversal with constant-time comparison and mapping functions.
Two complexity details deserve a close look:
lvlValues()has an O(n²) worst-case bound because the inherited implementation shifts an array queue.from()takes O(n) when copying a RedBlackTree withoutcompareormap. Supplying either option requires reinsertion, with an O(n log n) bound.Both
from()overloads document deduplication. The examples use scoped imports and assertions, and short comments identify the insertion and removal balancing cases. Public documentation uses@typeParamand{@linkcode}consistently.Validation:
env -u NO_COLOR deno task okpasses, including 7,446 tests and 3,269 steps. All nine RedBlackTree doc examples and 14 unit tests also pass individually, as doesdeno doc --lint data_structures/mod.ts. Emitted JavaScript matches the PR base exactly.The first full run hit color assertions with
NO_COLORset and one filesystem abort-test failure. The targeted rerun and full rerun passed.I used Claude Code to help investigate and write this change, and Codex to review and correct the documentation.