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: Added features document. Some corrections to components presence #1662

Merged
merged 2 commits into from
Feb 1, 2024

Conversation

jcpitre
Copy link
Contributor

@jcpitre jcpitre commented Feb 1, 2024

Summary:

Closes #1661

Added a document with the list of components-features and how we determine if they are present.
Removed Blocks component
Corrected the code where components were duplicated because of a typo in their name,

Expected behavior:
I expect no change of behavior.

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

  • 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 Feb 1, 2024 that may be closed by this pull request
Copy link
Contributor

github-actions bot commented Feb 1, 2024

✅ Rule acceptance tests passed.
New Errors: 0 out of 1480 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1480 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1480 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1480 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
1 out of 1481 sources (~0 %) are corrupted.
Corrupted sources:
br-minas-gerais-empresa-de-transportes-e-transito-de-belo-horizonte-bhtrans-gtfs-9
Commit: 1649ca3
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@jcpitre jcpitre requested review from emmambd and qcdyx February 1, 2024 14:02
@jcpitre
Copy link
Contributor Author

jcpitre commented Feb 1, 2024

@qcdyx I made some changes in the code that you could review. You don't need to review the markdown file.

Copy link
Contributor

@emmambd emmambd left a comment

Choose a reason for hiding this comment

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

@jcpitre This looks good! I think it would be good to link to the public GTFS components document in the "list of components" text at the top.

docs/features.md Outdated

The validator will list the list of components that it finds in the processed feed according to this table:

| Component | Feature | How is the presence of a featuree determined (minimum requirements) |
Copy link
Contributor

Choose a reason for hiding this comment

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

typo: featuree should be feature

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Repaired

@jcpitre
Copy link
Contributor Author

jcpitre commented Feb 1, 2024

@jcpitre This looks good! I think it would be good to link to the public GTFS components document in the "list of components" text at the top.
I thought the public GTFS components document was more a work document that was not that permanent.

@emmambd
Copy link
Contributor

emmambd commented Feb 1, 2024

@jcpitre This looks good! I think it would be good to link to the public GTFS components document in the "list of components" text at the top.

I thought the public GTFS components document was more a work document that was not that permanent.

It's being used in public facing meetings, so we can go ahead and add it. It's important context for anyone who reads the documentation and doesn't know what components are.

Copy link
Contributor

github-actions bot commented Feb 1, 2024

✅ Rule acceptance tests passed.
New Errors: 0 out of 1471 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1471 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1471 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1471 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
10 out of 1481 sources (~1 %) are corrupted.
Corrupted sources:
ca-ontario-grand-river-transit-gtfs-721
es-barcelona-tram-gtfs-1003
fr-normandie-neva-gtfs-1887
fr-pays-de-la-loire-ter-pays-de-la-loire-gtfs-1153
th-chiang-mai-chiang-mai-university-cmu-gtfs-1310
us-california-humboldt-county-gtfs-19
us-illinois-champaign-urbana-mass-transit-district-mtd-gtfs-388
us-iowa-sioux-city-transit-system-gtfs-191
us-vermont-advance-transit-gtfs-631
us-washington-pacific-transit-gtfs-242
Commit: 7ebde85
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@jcpitre
Copy link
Contributor Author

jcpitre commented Feb 1, 2024

It's being used in public facing meetings, so we can go ahead and add it. It's important context for anyone who reads the documentation and doesn't know what components are.

Added the link

@jcpitre jcpitre requested a review from emmambd February 1, 2024 18:26
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

Copy link
Contributor

@emmambd emmambd left a comment

Choose a reason for hiding this comment

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

LGTM

@jcpitre jcpitre merged commit b76ce1f into master Feb 1, 2024
333 checks passed
@jcpitre jcpitre deleted the 1661-add-documentation-on-logic-for-gtfs-components branch February 1, 2024 21:06
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.

Add documentation on logic for GTFS components
3 participants