Skip to content

docs: replace stub doc comments in priority_queue and immut packages#3308

Merged
bobzhang merged 5 commits intomainfrom
hongbo/docs-misc-comments
Mar 19, 2026
Merged

docs: replace stub doc comments in priority_queue and immut packages#3308
bobzhang merged 5 commits intomainfrom
hongbo/docs-misc-comments

Conversation

@bobzhang
Copy link
Contributor

Summary

Replace remaining stub doc comments across 4 packages:

  • priority_queue: Return length.Returns the number of elements in the queue., etc.
  • immut/array: Return whether the value empty.Returns true if the array contains no elements.
  • immut/sorted_set: Create a new instance.Creates an empty immutable sorted set.
  • immut/sorted_map: Create a new map with a key-value pair inserted.Returns a new map with the key-value pair added or updated.

Test plan

  • moon check passes

🤖 Generated with Claude Code

…/sorted_set, immut/sorted_map

Replace generic stubs like "Return length.", "Create from iter.",
"Convert to array.", "Return true if value contain in sorted_set"
with clear, descriptive doc comments.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
devin-ai-integration[bot]

This comment was marked as resolved.

@coveralls
Copy link
Collaborator

coveralls commented Mar 18, 2026

Pull Request Test Coverage Report for Build 2946

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 95.756%

Totals Coverage Status
Change from base Build 2923: 0.0%
Covered Lines: 13763
Relevant Lines: 14373

💛 - Coveralls

bobzhang and others added 4 commits March 18, 2026 22:03
…_map, immut/sorted_set, immut/priority_queue, immut/array

Replace "Create from iter.", "Convert to array.", "Return an iterator
via iter." stubs with clear descriptions.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@bobzhang bobzhang merged commit e518c6f into main Mar 19, 2026
14 checks passed
@bobzhang bobzhang deleted the hongbo/docs-misc-comments branch March 19, 2026 00:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants