Skip to content

Vasttrafik sensor configuration variable style #6414

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

Merged
merged 7 commits into from
Oct 2, 2018
Merged

Vasttrafik sensor configuration variable style #6414

merged 7 commits into from
Oct 2, 2018

Conversation

fredrikbaberg
Copy link
Contributor

@fredrikbaberg fredrikbaberg commented Oct 1, 2018

Change to new style for configuration variables description.

Related to #6385.

Description:

Update style of Västtrafik sensor documentation to follow new configuration variables description.

Pull request in home-assistant (if applicable): home-assistant/home-assistant#

Checklist:

  • Branch: next is for changes and new documentation that will go public with the next home-assistant release. Fixes, changes and adjustments for the current release should be created against current.
  • The documentation follow the standards.

Change to new style for configuration variables description (#6385).
@ghost ghost added the to-do label Oct 1, 2018
Copy link
Contributor

@WofWca WofWca left a comment

Choose a reason for hiding this comment

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

No need to quote the description text.
Not description: "The API secret to access your Västtrafik account."
but description: The API secret to access your Västtrafik account.

@fredrikbaberg fredrikbaberg changed the title WIP: Vasttrafik sensor configuration variable style Vasttrafik sensor configuration variable style Oct 1, 2018
lines:
description: Only consider these lines.
required: false
type: string
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it is supposed to be described as a list of strings (list, string), but home-assistant/developers.home-assistant#104 is not resolved yet.

departures:
description: List of travel routes.
required: true
type: map
Copy link
Contributor

Choose a reason for hiding this comment

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

And this may be a list of mappings.

@ghost ghost assigned fabaff Oct 2, 2018
@ghost ghost added ready-for-review This PR needs to be reviewed and removed to-do labels Oct 2, 2018
Copy link
Member

@fabaff fabaff left a comment

Choose a reason for hiding this comment

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

Thanks 🐦

@fabaff fabaff merged commit a2ba9f4 into home-assistant:current Oct 2, 2018
@fabaff fabaff added the Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! label Oct 2, 2018
@ghost ghost removed the ready-for-review This PR needs to be reviewed label Oct 2, 2018
@frenck frenck added enhancement current This PR goes into the current branch labels Oct 2, 2018
@fredrikbaberg fredrikbaberg deleted the patch-1 branch October 4, 2018 06:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
current This PR goes into the current branch Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants