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

docs: Clarified below threshold language in notices #1886

Merged
merged 2 commits into from
Oct 11, 2024
Merged

docs: Clarified below threshold language in notices #1886

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
991c78a
add greater than 0 lang to desc
emmambd Oct 10, 2024
74d626f
formatting fix
emmambd Oct 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .../main/java/org/mobilitydata/gtfsvalidator/validator/ShapeIncreasingDistanceValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,11 +239,11 @@ static class EqualShapeDistanceDiffCoordinatesNotice extends ValidationNotice {

/**
* Two consecutive points have equal `shape_dist_traveled` and different lat/lon coordinates in
* `shapes.txt` and the distance between the two points is less than 1.11m.
* `shapes.txt` and the distance between the two points is greater than 0 but less than 1.11m.
*
* <p>When sorted by `shape.shape_pt_sequence`, the values for `shape_dist_traveled` must increase
* along a shape. Two consecutive points with equal values for `shape_dist_traveled` and small
* difference of coordinates (less than 1.11 m distance) result in a warning.
* difference of coordinates (greater than 0 but less than 1.11 m distance) result in a warning.
*/
@GtfsValidationNotice(
severity = WARNING,
Expand Down
3 changes: 2 additions & 1 deletion ...src/main/java/org/mobilitydata/gtfsvalidator/validator/TripAndShapeDistanceValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,8 @@ static class TripDistanceExceedsShapeDistanceNotice extends ValidationNotice {
}

/**
* The distance between the last shape point and last stop point is less than the 11.1m threshold.
* The distance between the last shape point and last stop point is greater than 0 but less than
* the 11.1m threshold.
Copy link
Contributor

Choose a reason for hiding this comment

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

Out of scope, and I guess I should know that by now, but why do we sometimes talk about 11.1m and sometimes 1.11m?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it's a long story :) We defined different thresholds per notice. Specific references to the rationale for each are in the 5.0 release notes: https://github.com/MobilityData/gtfs-validator/releases/tag/v5.0.0

*/
@GtfsValidationNotice(
severity = WARNING,
Expand Down
Loading