Add Javadoc for Trip #6022
Merged
Add Javadoc for Trip #6022
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
optionsome
reviewed
Aug 29, 2024
| /** | ||
| * A Trip represents the movement of a public transport vehicle on a given {@link Route}, using a | ||
| * given {@link TransitMode}, on a given sequence of stops served at given passing times. | ||
| * <p>A Trip can run at most once per service date. |
There was a problem hiding this comment.
Should be rephrased as :
A scheduled Trip can run at most once per service date, while a frequency-based Trip runs several times on a given service date.
There was a problem hiding this comment.
This sounds good. If you add this, I will approve.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev-2.x #6022 +/- ##
==========================================
Coverage 69.73% 69.74%
- Complexity 17314 17319 +5
==========================================
Files 1960 1960
Lines 74267 74273 +6
Branches 7603 7605 +2
==========================================
+ Hits 51793 51800 +7
+ Misses 19831 19830 -1
Partials 2643 2643 ☔ View full report in Codecov by Sentry. |
leonardehrenfried
approved these changes
Sep 9, 2024
leonardehrenfried
approved these changes
Sep 9, 2024
optionsome
approved these changes
Sep 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The Javadoc is missing on the Trip class.
This PR attempts to clarify the definition of a Trip and show how Trip interacts with other entities in the model.
Issue
No
Unit tests
No
Documentation
Added Javadoc