-
-
Notifications
You must be signed in to change notification settings - Fork 7.8k
direction uses station id #39045
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
base: current
Are you sure you want to change the base?
direction uses station id #39045
Conversation
make it clearer that you need to use the hafas id
variable "direction" needs the station id instead of the station name
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe documentation for the RMV transport integration was updated to clarify the use of "HAFAS_ID" station IDs, revise the description of the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
User ->> Documentation: Reads RMV transport integration guide
Documentation -->> User: Explains use of "HAFAS_ID" for station IDs
Documentation -->> User: Provides example sensor configuration with ID-based direction
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/rmvtransport.markdown (1)
24-24
: Nitpick: Use 'website' as one word
Modern usage favors "website" over "web site".
Suggest updating:- Visit the [RMV OpenData web site](https://opendata.rmv.de) to find a list of valid station IDs. You will need to use the "HAFAS_ID". + Visit the [RMV OpenData website](https://opendata.rmv.de) to find a list of valid station IDs. You will need to use the "HAFAS_ID".🧰 Tools
🪛 LanguageTool
[style] ~24-~24: Nowadays, it’s more common to write this as one word.
Context: ...tes. ## Setup Visit the RMV OpenData web site to find a lis...(RECOMMENDED_COMPOUNDS)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/rmvtransport.markdown
(3 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/rmvtransport.markdown
[style] ~24-~24: Nowadays, it’s more common to write this as one word.
Context: ...tes. ## Setup Visit the RMV OpenData web site to find a lis...
(RECOMMENDED_COMPOUNDS)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (3)
source/_integrations/rmvtransport.markdown (3)
64-64
: Clarify 'direction' expects an ID
The updated description correctly specifies that thedirection
field requires a HAFAS ID (e.g.,3000912
), aligning with the RMV API behavior and improving accuracy for users.
119-122
: Approve example using station ID fordirection
The new fourth sensor example correctly demonstrates using station IDs for bothstation
anddirection
. The YAML indentation and syntax are consistent with the preceding examples.
130-131
: Approve explanatory text for the fourth sensor
The added line clearly explains the behavior of the new sensor: it returns connections from Niederrad Bahnhof going to or over Frankfurt Hauptbahnhof. This aligns well with the example configuration.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This never worked for me. When i tried using the station id it worked.
Is that a bug or intended functionality that this actually doesn't work? Have you verified that?
../Frenck
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
i saw that the code in the library uses |
There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. |
Proposed change
I changed the documentation so that it tells users to use the station id instead of the station name for "direction".
For the "direction" variable, the documentation tells me to use the station name. This never worked for me. When i tried using the station id it worked.
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit
direction
option to require a station ID instead of a station name.