-
Notifications
You must be signed in to change notification settings - Fork 101
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
Docs: Fix RULES.md notice name for 2 notices #1323
Conversation
@isabelle-dr What's the best way to test this? It doesn't look like the rule link is broken within |
This contribution does not follow the conventions set by the Google Java style guide. Please run the following command line at the root of the project to fix formatting errors: |
@emmambd you're right, the link isn't broken actually. The user is manually scraping RULES.md to get the description of the notices (and I think they then match with what is found in the JSON report). Here is a sample of the JSON report that this dataset creates, for example. {"notices":[{
"code":"feed_expiration_date7_days",
"severity":"WARNING",
"totalNotices":1 Then when parsing RULES.md with the notice code, the user calls @lauriemerrell is this accurate, and is this PR solving the problem? Here is the JAR that includes the modifications in this PR. |
✅ Rule acceptance tests passed. |
Thanks @isabelle-dr! TLDR: I do think that this PR would solve the problem. Longer explanation of what we're actually doing: in our pipeline (separate from the web validator work), we are trying to join notices data in the warehouse based on the code names that are scraped from RULES.md to get the longer descriptions (rather than automatically generating the link as described here, though the principle is similar). So we have a table with rows that correspond to validator notices, and they are keyed on the values that come from the validator ( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @lauriemerrell for your in depth explanation! It's clearer now that this PR is solving the problem of notices matching.
Thank you @lauriemerrell, merging this PR then. I am sending you an invite for the contributor meeting, hope you can make it! |
* fix RULES.md * empty commit to trigger tests * revert commit
* fix RULES.md * empty commit to trigger tests * revert commit
Summary:
Closes #1322
Expected behavior:
~~When either
feed_expiration_date7_days
orfeed_expiration_date30_days
is triggered, the link in the HTML report isn't broken. ~~EDIT: the notice name in the validation report is the same than the notice name in RULES.md for these two notices.
Please make sure these boxes are checked before submitting your pull request - thanks!
[ ] Run the unit tests withgradle test
to make sure you didn't break anything[ ] Include screenshot(s) showing how this pull request works and fixes the issue(s)