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

Embed isClass and stack_frame as types #40

Conversation

sarahsonder
Copy link
Collaborator

@sarahsonder sarahsonder commented Jun 4, 2024

Proposed Changes

This PR removes the isClass and stack_frame attributes and embeds them as the types .class and .frame. In addition, the input for the blank type has been changed from BLANK to .blank, and blank stack frames are now denoted by the type .blank-frame. These changes serve to streamline the process of drawing objects, classes, and stack frames while also reducing the complexity of the user input.

Type of Change

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change) X
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) X
📚 Documentation update (change that only updates documentation) X
📦 Dependency update (change that updates a dependency)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

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

@coveralls
Copy link
Collaborator

coveralls commented Jun 4, 2024

Pull Request Test Coverage Report for Build 9408747160

Details

  • 11 of 11 (100.0%) changed or added relevant lines in 3 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.7%) to 87.519%

Totals Coverage Status
Change from base Build 9376313216: 0.7%
Covered Lines: 386
Relevant Lines: 427

💛 - Coveralls

@sarahsonder sarahsonder requested a review from david-yz-liu June 4, 2024 01:38
@sarahsonder sarahsonder changed the title Turn is class and stackframe to types Turn isClass and stack_frame into types Jun 4, 2024
@sarahsonder sarahsonder changed the title Turn isClass and stack_frame into types Embed isClass and stack_frame as types Jun 4, 2024
docs/docs/03-automation_algorithms.md Outdated Show resolved Hide resolved
memory-viz/src/automate.ts Outdated Show resolved Hide resolved
memory-viz/src/automate.ts Outdated Show resolved Hide resolved
@sarahsonder sarahsonder requested a review from david-yz-liu June 4, 2024 17:17
@sarahsonder sarahsonder requested review from david-yz-liu and removed request for david-yz-liu June 5, 2024 19:54
@sarahsonder sarahsonder requested a review from david-yz-liu June 6, 2024 22:38
@david-yz-liu david-yz-liu merged commit 4e9a126 into david-yz-liu:master Jun 7, 2024
3 checks passed
@sarahsonder sarahsonder deleted the turn-isClass-and-stackframe-to-types branch June 7, 2024 16:00
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