docs: standardize API documentation across all packages#2
Merged
Conversation
- Add doc.go files for all packages with consistent documentation style - Move package-level docs to doc.go files - Standardize iterator function docs with Parameters, Returns, Time Complexity sections - Replace custom comparators with cmp.Compare/Ordered constructors in tests - Fix linter issues (ineffassign, deprecated rand.Seed) - Remove unused code (unused private functions)
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
1 participant
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.
Summary
This PR standardizes API documentation across all packages in the ds library:
Changes Made
Added doc.go files for all packages with comprehensive package-level documentation including:
Standardized iterator function documentation across all packages:
btree,btreemap,btreesetskipmap,skipsethashmap,hashsetarraydeque,arraystack,linkedlisttrieConsistent documentation structure:
Parameters:sectionReturns:section with return type descriptionTime Complexity:for all operationsBehavior:section when applicableTest improvements:
cmp.Compare/NewOrderedconstructorsLinter fixes:
ineffassignissuesrand.SeedcallsFiles Changed
Testing
All tests pass: