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

feat: Add examples table for mixed_case_recommended_field #1708

Merged
merged 9 commits into from
Mar 13, 2024

Conversation

emmambd
Copy link
Contributor

@emmambd emmambd commented Mar 12, 2024

Summary:

Closes #1625 to

  • remove code reference
  • add example tables

Expected behavior:

Includes table of good and bad examples related to this notice.

Please make sure these boxes are checked before submitting your pull request - thanks!

  • [X ] Run the unit tests with gradle test to make sure you didn't break anything
  • [X ] Add or update any needed documentation to the repo
  • [X ] Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • [X ] Linked all relevant issues
  • [X ] Include screenshot(s) showing how this pull request works and fixes the issue(s)
Screenshot 2024-03-12 at 11 26 32 AM Screenshot 2024-03-13 at 11 25 29 AM

Testing:

Example feed

  • Check Web UI
  • Check HTML report

@emmambd emmambd marked this pull request as draft March 12, 2024 14:54
@emmambd emmambd marked this pull request as ready for review March 12, 2024 15:29
Copy link
Contributor

✅ Rule acceptance tests passed.
New Errors: 0 out of 1520 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1520 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1520 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1520 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1520 sources (~0 %) are corrupted.
Commit: 8e4a816
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@davidgamez
Copy link
Member

This is how the mixed case notice looks like with a HTML caption tag on the table
Rendering on the web:
Screenshot 2024-03-12 at 3 03 14 PM

Rendering on local HTML report:
Screenshot 2024-03-12 at 3 08 45 PM

@emmambd
Copy link
Contributor Author

emmambd commented Mar 12, 2024

Modified HTML report style:

Screenshot 2024-03-12 at 3 55 46 PM

Copy link
Contributor

✅ Rule acceptance tests passed.
New Errors: 0 out of 1520 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1520 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1520 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1520 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1520 sources (~0 %) are corrupted.
Commit: c985e28
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@emmambd emmambd requested a review from qcdyx March 13, 2024 15:30
Copy link
Contributor

✅ Rule acceptance tests passed.
New Errors: 0 out of 1520 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1520 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1520 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1520 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1520 sources (~0 %) are corrupted.
Commit: eaa6e8b
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

Copy link
Contributor

@qcdyx qcdyx left a comment

Choose a reason for hiding this comment

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

LGTM

@qcdyx qcdyx merged commit 4029a37 into master Mar 13, 2024
334 checks passed
@qcdyx qcdyx deleted the 1625-mixedcase-examples branch March 13, 2024 17:29
Copy link
Contributor

✅ Rule acceptance tests passed.
New Errors: 0 out of 1520 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1520 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1520 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1520 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1520 sources (~0 %) are corrupted.
Commit: 466687a
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests 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.

Change link to the Java annotation in the documentation for mixed_case_recommended_field
3 participants