Skip to content

Add documentation for counter component#3250

Merged
fabaff merged 2 commits into
nextfrom
counter
Aug 29, 2017
Merged

Add documentation for counter component#3250
fabaff merged 2 commits into
nextfrom
counter

Conversation

@fabaff
Copy link
Copy Markdown
Member

@fabaff fabaff commented Aug 26, 2017

Description:
Add documentation for counter component.

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

@fabaff fabaff added the new-integration This PR adds documentation for a new Home Assistant integration label Aug 26, 2017
Copy link
Copy Markdown
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

⚠️ Found some spelling & grammar issues.

@fabaff Could you please take a look?

Comment thread source/_components/counter.markdown Outdated

| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of entity to take the action, e.g. `counter.count0`. |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Spelling & Grammar:

  • Name of entity -> `Name of the entity``
  • e.g. -> e.g., (missing comma)
  • take the action -> take action

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Thanks

Comment thread source/_components/counter.markdown Outdated

| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of entity to take the action, e.g. `counter.count0`. |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Same spelling & grammar issues as mentioned above.

Comment thread source/_components/counter.markdown Outdated

| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of entity to take the action, e.g. `counter.count0`. |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Same spelling & grammar issues as mentioned in my first comment.


#### {% linkable_title Service `counter/reset` %}

With this service the counter is reset to its initial value.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Spelling & Grammar:

  • Missing comma after service -> With this service, the counter


### {% linkable_title Use the service %}

Select <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services** from the **Developer Tools**. Choose **counter** from the list of **Domains**, select the **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Is the image missing?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nevermind, my bad, you can ignore this one 😅

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This is an issue with Github preview. Will only be visible after deployment.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm actually running branches locally when reviewing...
Nevertheless, it was an issue on my end 👍

@frenck
Copy link
Copy Markdown
Member

frenck commented Aug 26, 2017

Thx @fabaff 🥇

@fabaff fabaff merged commit edd35b2 into next Aug 29, 2017
@fabaff fabaff deleted the counter branch August 29, 2017 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new-integration This PR adds documentation for a new Home Assistant integration

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants