Documentation beginnings#22
Open
phill44-source wants to merge 4 commits intooffenesdresden:masterfrom
Open
Conversation
Updated comments for 'line' and 'direction' attributes in Departure and PartialRoute classes to provide examples.
Classes docs for all Classes except for RouteChange and ValidityPeriod
kiliankoe
reviewed
Mar 16, 2026
| line: str | ||
| direction: str # destination name | ||
| line: str # e.g. 3, 8, RE80 | ||
| direction: str # Most commonly name of last Station |
Member
There was a problem hiding this comment.
Not sure about this change, the VVO/DVB itself describe it as the destination name, and I'd like to keep that wording. Some destinations like "Btf Trachenberge" are specifically not stations.
kiliankoe
reviewed
Mar 16, 2026
| id: str | ||
| line: str | ||
| direction: str # destination name | ||
| line: str # e.g. 3, 8, RE80 |
Member
There was a problem hiding this comment.
Suggested change
| line: str # e.g. 3, 8, RE80 | |
| line: str # e.g. "3", "8", "RE80" |
Examples are good, but please keep the formatting and make the types clear.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.