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.

Sign up for GitHub

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

Jump to bottom

Minor documentation changes #1658

Merged
merged 3 commits into from
Jan 25, 2024
Merged

Minor documentation changes #1658

merged 3 commits into from
Jan 25, 2024

Conversation

jcpitre
Copy link
Contributor

@jcpitre jcpitre commented Jan 24, 2024

Summary:

Added a little bit of documentation related to #1628

  • Run the unit tests with gradle test to make sure you didn't break anything
  • Add or update any needed documentation to the repo
  • Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • Linked all relevant issues
  • Include screenshot(s) showing how this pull request works and fixes the issue(s)
@jcpitre jcpitre linked an issue Jan 24, 2024 that may be closed by this pull request
Allow the validator to accept a "time of validation" argument #1292
Closed
emmambd
emmambd reviewed Jan 24, 2024
View reviewed changes
docs/USAGE.md Outdated
@@ -20,7 +20,8 @@
| `-r` | `--html_report_name` | Optional | Name of the HTML validation report (including `.html` extension). |
| `-e` | `--system_errors_report_name` | Optional | Name of the system errors report (including `.json` extension). |
| `-n` | `--export_notices_schema` | Optional | Export notice schema as a json file. |
| `-p` | `--pretty` | Optional | Pretty JSON validation report. If specified, the JSON validation report will be printed using JSON Pretty print. This does not impact data parsing. |
| `-p` | `--pretty` | Optional | Pretty JSON validation report. If specified, the JSON validation report will be printed using JSON Pretty print. This does not impact data parsing. |
| `-d` | `--date` | Optional | Date to simulate when validating, in ISO_LOCAL_DATE format like '2001-01-30'. By default, the current date is used. |
Copy link
Contributor

Choose a reason for hiding this comment

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

@jcpitre "Date to simulate when validating" is a bit vague. What about "The date used to validate the feed for time-based rules, e.g feed_expiration_30_days."
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure. I was just copying the text from @bradyhunsaker's changes, but less vague is always good.
davidgamez
davidgamez approved these changes Jan 24, 2024
View reviewed changes
Copy link
Member

@davidgamez davidgamez left a comment

Choose a reason for hiding this comment

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

LGTM 💪 !
@github-actions GitHub Actions
Copy link
Contributor

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

Sorry that I overlooked updating this file with the original change.
@jcpitre
Copy link
Contributor Author

jcpitre commented Jan 25, 2024 •
edited
Loading

Sorry that I overlooked updating this file with the original change.

@bradyhunsaker You did a lot already. I'm happy to take care of small details like this
@github-actions GitHub Actions
Copy link
Contributor

✅ Rule acceptance tests passed.
New Errors: 0 out of 1481 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1481 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1481 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1481 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1481 sources (~0 %) are corrupted.
Commit: f27ba14
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.
@jcpitre jcpitre merged commit 48facc3 into master Jan 25, 2024
333 checks passed
@jcpitre jcpitre deleted the 1292-minor-documentation-changes-for-the-date-feature branch January 25, 2024 18:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
4 participants
@jcpitre @bradyhunsaker @davidgamez @emmambd