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

Make isClass optional #35

Merged
merged 8 commits into from
May 30, 2024

Conversation

sarahsonder
Copy link
Collaborator

@sarahsonder sarahsonder commented May 23, 2024

Proposed Changes

  • Updated documentation, tests, and examples to reflect the isClass attribute being optional and set to false by default. Previously isClass was manually set to false - this is no longer necessary and simplifies the user input into MemoryViz.
  • Fixed some minor typos in 02-object_structure.md, such as standardizing the spelling of stack frame.
  • Added indentation to the first two examples in 02-object_structure.md so that users don't need to screen horizontally to see the full example.

Type of Change

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change that adds functionality)
🐛 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) X
🚦 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 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.

@sarahsonder sarahsonder marked this pull request as ready for review May 23, 2024 04:01
@coveralls
Copy link
Collaborator

coveralls commented May 23, 2024

Pull Request Test Coverage Report for Build 9237530555

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 86.781%

Totals Coverage Status
Change from base Build 9230691981: 0.0%
Covered Lines: 380
Relevant Lines: 423

💛 - Coveralls

@sarahsonder sarahsonder requested a review from david-yz-liu May 23, 2024 14:13
@sarahsonder sarahsonder requested a review from david-yz-liu May 25, 2024 18:59
@david-yz-liu david-yz-liu merged commit 0e1777f into david-yz-liu:master May 30, 2024
3 checks passed
@sarahsonder sarahsonder deleted the make-isClass-optional branch May 30, 2024 22:33
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