Skip to content

Documentation beginnings #22

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

Open
phill44-source wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Documentation beginnings #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6c96ce7
Enhance comments for line and direction attributes
phill44-source Mar 13, 2026
ee21fb8
Update comment for direction field in Departure model
phill44-source Mar 13, 2026
be7a7fc
Create Docs.md
phill44-source Mar 13, 2026
62b4c31
Added Classes Docs
phill44-source Mar 13, 2026
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
Binary file added documentation/DVBpy Classes.dia
View file
Open in desktop
Binary file not shown.
Binary file added documentation/DVBpy Classes.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions documentation/Docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

8 changes: 4 additions & 4 deletions dvb/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ class Departure:
"""A single upcoming departure from a stop."""

id: str
line: str
direction: str # destination name
line: str # e.g. 3, 8, RE80
Copy link
Member

@kiliankoe kiliankoe Mar 16, 2026

Choose a reason for hiding this comment

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

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.

direction: str # Most commonly name of last Station
Copy link
Member

@kiliankoe kiliankoe Mar 16, 2026

Choose a reason for hiding this comment

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

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.

scheduled: datetime
real_time: datetime | None = None
state: str = "" # real-time state, e.g. "InTime", "Delayed"
Expand Down Expand Up @@ -62,9 +62,9 @@ class PartialRoute:
"""A single leg of a planned route, e.g. one tram ride within a multi-transfer journey."""

duration: int # in minutes
line: str
line: str # e.g. 3, 8, RE80
mode: str # e.g. "Tram", "CityBus", "Footpath", "StayForConnection"
direction: str
direction: str # Most commonly name of last Station
stops: list[RegularStop]
cancelled: bool = False
changeover_endangered: bool = False # transfer to the next leg is at risk
Expand Down