Skip to content
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

Updated Abode docs to point to jaraco.abode library #32722

Merged
merged 3 commits into from
May 14, 2024

Conversation

jaraco
Copy link
Contributor

@jaraco jaraco commented May 13, 2024

Proposed change

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:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

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.

@home-assistant home-assistant bot added the current This PR goes into the current branch label May 13, 2024
Copy link

netlify bot commented May 13, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 16e9619
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/664384aaf947a7000818d548
😎 Deploy Preview https://deploy-preview-32722--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@@ -81,8 +81,8 @@ All {% term events %} have the fields:
| `date` | The date of the event in the format `MM/DD/YYYY`. |
| `time` | The time of the event in the format `HH:MM AM`. |

There is a unique list of known event_codes that can be found
[here](https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt).
There is a unique list of known event_codes are defined in
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is the link to abodepy removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I had checked the URL and thought it was 404. Turns out it wasn't 404, but when I first browsed to the URL, I included the trailing ), which was 404, then when I corrected it and removed the trailing ), Firefox quietly downloaded the file and left me on the 404 page (leading me to believe the URL itself was 404).

So I sought to find a suitable replacement in the jaraco.abode project, which supersedes the abodepy project. Now that I see the contents of timeline_events.txt, I see there is a bit of extra information in that text file, information which is lost outside of the previous project's GitHub repo. I'll restore that content in the project itself.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Aha. I see now that the "groups" is codified as well, so I'll update the docs to link to that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in cf6e9d6.

c0ffeeca7
c0ffeeca7 previously approved these changes May 14, 2024
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @jaraco 👍

@c0ffeeca7 c0ffeeca7 merged commit a61cc6a into home-assistant:current May 14, 2024
6 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators May 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants