[Base] move DistributedDataShared to standalone header & add tests#1169
[Base] move DistributedDataShared to standalone header & add tests#1169tdavidcl merged 7 commits intoShamrock-code:mainfrom
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @tdavidcl, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
I've refactored the DistributedDataShared class by moving it to its own standalone header file to improve code organization and maintainability. This change also allowed for the addition of a dedicated and comprehensive suite of unit tests for the class, ensuring its reliability. Necessary include path updates have been made across the affected files.
Highlights
- Code Refactoring: The
DistributedDataSharedclass has been extracted fromshambase/DistributedData.hppand moved into its own dedicated header file,shambase/DistributedDataShared.hpp. This improves modularity and organization within the codebase. - New Unit Tests: A new, comprehensive unit test file,
src/tests/shambase/DistributedDataShared.cpp, has been added. This file includes extensive tests for all core functionalities of theDistributedDataSharedclass, ensuring its correctness and stability. - Dependency Updates: Updated include paths across various files (
distributedDataComm.hpp,GhostZoneData.hppin both ramses and zeus, andGhostZones.cpp) to reflect the new location of theDistributedDataSharedheader. - Minor Code Cleanup: A minor refactoring in
shambase/DistributedData.hppinvolved replacinglogger::raw_lnwithprint_ln, along with the removal of theshamcomm/logs.hppinclude, streamlining the printing mechanism.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request successfully refactors the DistributedDataShared class into its own header file, improving code organization. New unit tests have been added, which is great for ensuring correctness. My review focuses on the implementation of DistributedDataShared, with suggestions to improve performance and maintainability by using modern C++ features more effectively, such as templated callables over std::function and more efficient map iteration.
Workflow reportworkflow report corresponding to commit cc10aa7 Pre-commit check reportPre-commit check: ✅ Test pipeline can run. Clang-tidy diff reportNo relevant changes found. You should now go back to your normal life and enjoy a hopefully sunny day while waiting for the review. Doxygen diff with
|
No description provided.