Skip to content

feat: Extract notice docs from source-code for in-app use and schema export#1365

Merged
bdferris-v2 merged 8 commits intomasterfrom
issue/1324/notice_resources
Apr 7, 2023
Merged

feat: Extract notice docs from source-code for in-app use and schema export#1365
bdferris-v2 merged 8 commits intomasterfrom
issue/1324/notice_resources

Conversation

@bdferris-v2
Copy link
Copy Markdown
Collaborator

@bdferris-v2 bdferris-v2 commented Mar 27, 2023

Summary:

Per discussion in #1324, this PR adds support for extracting documentation from notice source code, to be included as JSON resources bundles in the compiled application. These will be included in the now-expanded JSON schema export feature, including comments, reference links, and hopefully enough info to generate RULES.md from source.

See https://bit.ly/gtfs-validator-notice-documentation for initial design discussion.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 27, 2023

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

@isabelle-dr isabelle-dr linked an issue Mar 27, 2023 that may be closed by this pull request
[feature request / refactor] Produce structured data containing human-readable code descriptions (refactor RULES.md) #1324
Closed
@bdferris-v2 bdferris-v2 requested a review from davidgamez March 27, 2023 17:01
@davidgamez
Copy link
Copy Markdown
Member

davidgamez commented Apr 5, 2023

@bdferris-v2 let's connect to discuss where the generated documentation can live to make it easily accessible to consumers.

davidgamez
davidgamez approved these changes Apr 5, 2023
View reviewed changes
Copy link
Copy Markdown
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
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 5, 2023

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 7, 2023

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

@bdferris-v2 bdferris-v2 merged commit f82bb5d into master Apr 7, 2023
@bdferris-v2 bdferris-v2 deleted the issue/1324/notice_resources branch April 7, 2023 18:20
bradyhunsaker pushed a commit to bradyhunsaker/gtfs-validator that referenced this pull request Apr 25, 2023
@bdferris-v2 @bradyhunsaker
feat: Extract notice docs from source-code for in-app use and schema …
503f8b6 
…export (MobilityData#1365)

* Initial entry for @GtfsValidationNotice annotation, which will be used to configure and document validation notices in source code.

* Move key annotation and entity interfaces into a new `model` module.  This will allow us to break up some potential circular dependencies with upcoming support for notice documentation generation.

* Initial entry for processor:notices module, with support for documentation extraction for notices.

* Fix test on Windows.
@bdferris-v2 bdferris-v2 mentioned this pull request May 1, 2023
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@davidgamez davidgamez davidgamez approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[feature request / refactor] Produce structured data containing human-readable code descriptions (refactor RULES.md)

2 participants

@bdferris-v2 @davidgamez