core chore: maintain map/set API consistency

Sep 06 '24 13:09 Lampese

[!IMPORTANT]

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Sep 06 '24 13:09 coderabbitai[bot]

Function Renaming Consistency:
- The function find was renamed to get in the HAMT.mbt file. However, the op_get function still calls self.find(key). This should be updated to self.get(key) to maintain consistency.
```
- pub fn op_get[K : Eq + Hash, V](self : T[K, V], key : K) -> V? {
-   self.find(key)
+ pub fn op_get[K : Eq + Hash, V](self : T[K, V], key : K) -> V? {
+   self.get(key)
}
```

Variable Naming Consistency:

In the HAMT_test.mbt file, the variable map is used to refer to a hash set in multiple tests. This can be confusing as map typically implies a key-value structure, not a set. Consider renaming map to set for clarity.

- test "Set" {
-   let map = loop 0, @hashset.new() {
-     100, map => map
-     i, map => continue i + 1, map.insert(i)
-   }
+ test "Set" {
+   let set = loop 0, @hashset.new() {
+     100, set => set
+     i, set => continue i + 1, set.insert(i)
+   }

Documentation Updates:

The documentation comments for functions like insert and get should be updated to reflect their new names. For example, the comment for insert should mention that it replaces add.

- /// Add a key-value pair to the hashmap.
+ /// Insert a key-value pair into the hashmap.
///
/// If a pair with the same key already exists, the old one is replaced
- pub fn insert[K : Eq + Hash, V](self : T[K, V], key : K, value : V) -> T[K, V] {
+ pub fn insert[K : Eq + Hash, V](self : T[K, V], key : K, value : V) -> T[K, V] {