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

Highlight box bug #38

Merged
merged 7 commits into from
Jun 5, 2024
Merged

Conversation

yoonieaj
Copy link
Collaborator

@yoonieaj yoonieaj commented May 27, 2024

Proposed Changes

Fixed a bug where the fill colour of boxes covered and hid the text in the box. This was done by changing the order in which elements are drawn.
Also changed the implementation of the hide style option. Now, this option sets text opacity to zero (before, it covered the text with a white box), so that the hide style option still works after the above bug fix.

...

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)
🐛 Bug fix (non-breaking change that fixes an issue) X
🎨 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

I went over the snapshots and it seems like they were failing because of the changed order in which elements were drawn, so I decided to update the snapshots and have included the updated versions in this PR.

@coveralls
Copy link
Collaborator

coveralls commented May 27, 2024

Pull Request Test Coverage Report for Build 9370168024

Details

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

Totals Coverage Status
Change from base Build 9327208107: 0.02%
Covered Lines: 381
Relevant Lines: 424

💛 - Coveralls

@yoonieaj yoonieaj requested a review from david-yz-liu May 27, 2024 18:13
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.

@yoonieaj good job. You fixed the immediate bug, but should look for all places where drawText is called, and make sure it's called after the corresponding drawRect calls. Otherwise this issue might come up again later.

CHANGELOG.md Outdated
@@ -24,6 +24,7 @@ and adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
- Added data type and manual layout tests for the `draw` function.
- Updated file paths for example files under docs to import the correct file.
- Added style and automatic layout tests for the `draw` function.
- Fixed highlight bug and changed implementation of `hide` style option.
Copy link
Owner

Choose a reason for hiding this comment

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

This change a bug fix, so should go under the "Bug fixes" section. You should describe in more detail what the bug is, but don't need to mention specific implementation details. I.e., focus on the what, not the how.

@yoonieaj yoonieaj requested a review from david-yz-liu June 4, 2024 15:49
@david-yz-liu david-yz-liu merged commit 636e261 into david-yz-liu:master Jun 5, 2024
3 checks passed
@yoonieaj yoonieaj deleted the highlight-box-bug branch September 17, 2024 00:41
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