Skip to content

Clarification for a moron ;) #3797

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 2 commits into from
Oct 27, 2017
Merged

Clarification for a moron ;) #3797

merged 2 commits into from
Oct 27, 2017

Conversation

arretx
Copy link
Contributor

@arretx arretx commented Oct 27, 2017

Often it helps to see the syntax for configuration variables...

Description:

I added the configuration variables to the example after testing the config. I'm still new at this and seeing how variables are used in YAML syntax in the examples helps me learn.

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

Often it helps to see the syntax for configuration variables...
@@ -22,6 +22,9 @@ To enable this sensor, add the following lines to your `configuration.yaml`:
# Example configuration.yaml entry
sensor:
- platform: uptime
#Optional configuration variables
Copy link
Member

Choose a reason for hiding this comment

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

We try to keep all configuration samples minimal. Thus, no optional requirement in the default sample. This helps user to get started quickly by copy-&-paste the sample without worrying about optional parameters which they most likely not need. If required, insert a full configuration sample later that covers special setups or alike.

@fabaff fabaff added Enhancement Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! labels Oct 27, 2017
@arretx
Copy link
Contributor Author

arretx commented Oct 27, 2017 via email

Something like this instead...
@fabaff fabaff merged commit e003f0b into home-assistant:current Oct 27, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

2 participants