Skip to content

Add documentation for Modbus cover#12687

Merged
frenck merged 3 commits into
home-assistant:nextfrom
Lutemi:feature/documentation-for-modbus-cover
Sep 29, 2020
Merged

Add documentation for Modbus cover#12687
frenck merged 3 commits into
home-assistant:nextfrom
Lutemi:feature/documentation-for-modbus-cover

Conversation

@vzahradnik
Copy link
Copy Markdown
Contributor

Proposed change

This PR adds documentation for the Modbus cover entity.

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase: Add Modbus cover core#33642
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue:

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

@probot-home-assistant probot-home-assistant Bot added has-parent This PR has a parent PR in another repo next This PR goes into the next branch labels Apr 4, 2020
@klaasnicolaas klaasnicolaas added the new-integration This PR adds documentation for a new Home Assistant integration label Apr 4, 2020
@vzahradnik
Copy link
Copy Markdown
Contributor Author

@frenck Due to recent changes in the parent PR, I reworked the documentation:
Before this change, cover configuration was part of the cover integration (which is not allowed for new integrations anymore):

cover:
  - platform: modbus
    covers:
      - name: Door1
        hub: hub1
...

After the change, the cover configuration is part of the modbus platform:

modbus:
  hubs:
    - name: hub1
      type: tcp
      host: IP_ADDRESS
      port: 502

  covers:
    - name: Door1
      hub: hub1
      ...

I'd like to ask if it's OK to create a separate page for the cover component. I checked other integrations, and they put the documentation into the main page, which is Modbus in my case. However, the cover documentation contains many examples to clarify it's use, and I think it's better to keep it in a separate page.

Thanks!

@frenck frenck added the parent-merged The parent PR has been merged already label Sep 29, 2020
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.

Awesome, thanks @vzahradnik 👍

@frenck frenck merged commit f172512 into home-assistant:next Sep 29, 2020
@probot-home-assistant probot-home-assistant Bot removed the parent-merged The parent PR has been merged already label Sep 29, 2020
@vzahradnik vzahradnik deleted the feature/documentation-for-modbus-cover branch September 29, 2020 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

has-parent This PR has a parent PR in another repo new-integration This PR adds documentation for a new Home Assistant integration next This PR goes into the next branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants