Skip to content
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.

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

Batch mode #107

Merged
merged 6 commits into from
Nov 30, 2024
Merged

Batch mode #107

merged 6 commits into from
Nov 30, 2024

Conversation

leowrites
Copy link
Collaborator

@leowrites leowrites commented Nov 28, 2024

Proposed Changes

This PR adds a batch mode to the MemoryViz API. Users can now input multiple snapshots to be drawn, and each snapshot will have its own MemoryModel instance.

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change that adds functionality) x
🐛 Bug fix (non-breaking change that fixes an issue)
🎨 User interface change (change to user interface; provide screenshots)
♻️ Refactoring (internal change to codebase, without changing functionality)
🚦 Test update (change that only adds or modifies tests)
📚 Documentation update (change that only updates documentation)
📦 Dependency update (change that updates a dependency)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

  • I have performed a self-review of my changes.
    • Check that all changed files included in this pull request are intentional changes.
    • Check that all changes are relevant to the purpose of this pull request, as described above.
  • I have added tests for my changes, if applicable.
    • This is required for all bug fixes and new features.
  • I have updated the project documentation, if applicable.
    • This is required for new features.
  • If this is my first contribution, I have added myself to the list of contributors.
  • I have updated the project Changelog (this is required for all changes).

After opening your pull request:

  • I have verified that the CI tests have passed.
  • I have reviewed the test coverage changes reported by Coveralls.
  • I have requested a review from a project maintainer.

Questions and Comments

(Include any questions or comments you have regarding your changes.)

Comment on lines 91 to 94
function getCanvasDimensions(
configuration: Partial<DisplaySettings>,
snapshotObjects: DrawnEntity[]
): void {
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@david-yz-liu I extracted this code for getting the canvas dimension in the manual mode. I was wondering if it would be better to move it into MemoryModel?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm yes, I think it's better to move into MemoryModel. Good suggestion

@leowrites leowrites marked this pull request as ready for review November 28, 2024 05:06
@coveralls
Copy link
Collaborator

coveralls commented Nov 28, 2024

Pull Request Test Coverage Report for Build 12098050130

Details

  • 33 of 33 (100.0%) changed or added relevant lines in 2 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.1%) to 88.802%

Totals Coverage Status
Change from base Build 11943314632: 0.1%
Covered Lines: 464
Relevant Lines: 503

💛 - Coveralls

Copy link
Owner

@david-yz-liu david-yz-liu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@leowrites thank you!

@david-yz-liu david-yz-liu merged commit db847f1 into david-yz-liu:master Nov 30, 2024
4 checks passed
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.

3 participants