8000 Fix SortedSet docs by bobzhang · Pull Request #2250 · moonbitlang/core · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fix SortedSet docs #2250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jun 11, 2025
Merged

Fix SortedSet docs #2250

merged 1 commit into from
Jun 11, 2025

Conversation

bobzhang
Copy link
Contributor

Summary

  • update docs for SortedSet
  • clean up outdated MutableSet references

Testing

  • moon test

https://chatgpt.com/codex/tasks/task_e_684949be1af48320bd712fe6356086dc

@peter-jerry-ye-code-review peter-jerry-ye code review
Copy link
peter-jerry-ye-code-review bot commented Jun 11, 2025 •
edited
Loading
Documentation comment inconsistency in function naming style

Category
Maintainability
Code Snippet
///|
/// Returns if the set is empty.
Recommendation
Update comment to be more descriptive and consistent with other function documentation: '///|
/// Returns true if the set contains no elements.'
Reasoning
The current documentation is terse and grammatically awkward. Making it more descriptive and consistent with common API documentation patterns would improve readability and maintainability.

Missing documentation details for clone operations

Category
Maintainability
Code Snippet
///|
/// Returns a shallow copy of the set.
///
/// It is just copying the tree structure, not the values.
Recommendation
Expand documentation to clarify behavior and use cases: '///|
/// Returns a shallow copy of the set.
///
/// Creates a new set with the same structure but sharing references to the original values.
/// Use deep_clone() if you need a complete copy including values.
///'
Reasoning
The current documentation could be clearer about the implications of shallow copying, especially for users who need to choose between shallow_clone and deep_clone.

Outdated reference to 'Show trait' in documentation

Category
Maintainability
Code Snippet
SortedSet implements to_string (i.e. Show trait), which allows you to directly output it.
Recommendation
Update documentation to be more precise: 'SortedSet implements to_string, allowing direct string conversion of the set contents.'
Reasoning
The reference to 'Show trait' seems to be borrowed from other languages (like Haskell) and might be confusing since it's not clear if MoonBit actually has a Show trait. It's better to describe the actual functionality without referencing concepts that might not exist in the language.

@bobzhang bobzhang force-pushed the codex/update-comments-for-mutableset-references branch from 8ee777d to dd667f6 Compare June 11, 2025 11:22
@bobzhang bobzhang enabled auto-merge (rebase) June 11, 2025 11:22
@bobzhang bobzhang merged commit 3c4974c into main Jun 11, 2025
8 of 12 checks passed
@bobzhang bobzhang deleted the codex/update-comments-for-mutableset-references branch June 11, 2025 11:30
@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 7220

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

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 93.087%
Totals Coverage Status
Change from base Build 7218: 0.0%
Covered Lines: 8551
Relevant Lines: 9186
💛 - Coveralls
702A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
codex
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@bobzhang @coveralls
0