core icon indicating copy to clipboard operation
core copied to clipboard

Reorganize collections

Open jialunzhang-psu opened this issue 1 year ago • 2 comments

This PR reorganizes containers into a new collections folder. There are two motivations:

  • The list of packages in core is getting lengthy.
  • After putting different containers into a separate collections folder, it becomes more convenient to share implementation between containers. For example, hashmap and hashset share the same underlying implementation. I split it out to be a separate package (robinhood_hash) and they both become wrappers over it.

What I did:

  • Created a new folder collections. Moved relevant packages into it.
  • Corrected dependency paths in other packages.
  • Create a new robinhood_hash package under collections. Rewrite hashset and hashmap to be just wrappers.

Unresolved issue:

  • core/collections/robinhood_hash is a package visible from the outside world. No idea how to make it local to collections.

Note:

  • I left vec and list outside of collections, since they are more commonly used.

jialunzhang-psu avatar Apr 27 '24 02:04 jialunzhang-psu

[!IMPORTANT]

Auto 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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

coderabbitai[bot] avatar Apr 27 '24 02:04 coderabbitai[bot]

Codecov Report

Attention: Patch coverage is 47.72727% with 23 lines in your changes are missing coverage. Please review.

Project coverage is 83.83%. Comparing base (ae44a64) to head (68aa713).

Files Patch % Lines
collections/hashmap/hashmap.mbt 0.00% 15 Missing :warning:
collections/hashset/hashset.mbt 77.27% 5 Missing :warning:
collections/robinhood_hash/robinhood_hash.mbt 0.00% 2 Missing :warning:
string/string.mbt 66.66% 1 Missing :warning:
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #324      +/-   ##
==========================================
- Coverage   84.55%   83.83%   -0.72%     
==========================================
  Files          73       74       +1     
  Lines        2874     2845      -29     
==========================================
- Hits         2430     2385      -45     
- Misses        444      460      +16     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Apr 27 '24 02:04 codecov[bot]

The orgnanization layout is mostly settled, thanks for your contributions

bobzhang avatar Jun 22 '24 09:06 bobzhang