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

Fix inconsistently spelled occurrences of "ID" in telegram_bot integration #135928

Merged
merged 2 commits into from
Jan 18, 2025

Conversation

NoRi2909
Copy link
Contributor

@NoRi2909 NoRi2909 commented Jan 18, 2025

Proposed change

This PR contains a collection of smaller strings fixes in the telegram_bot integration:

  • change all remaining occurrences of "id" or "Id" to the correct spelling "ID"
  • change "chat_id" to the UI-friedly "chat ID"
  • use "ID of the chat …" in descriptions, matching "ID of the message …"
  • fix the edit_replymarkup action's description to also use "Edits …", matching all other with "Sends …" or "Edits …"
  • replace "reply_markup" with "reply markup"
  • use translatable descriptions for the Timeout fields

The latter change uses the descriptions from the online documentation that can be translated while the current ones repeat the action name (in lowercase) which makes it difficult to handle in other languages.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

- change all remaining occurrences of "id" or "Id" to the correct spelling "ID"
- change "chat_id" to the UI-friedly "chat ID"
- use "ID of the chat …" in descriptions, matching "ID of the message …"
- fix the edit_replymarkup action's description to also use "Edits …", matching all other descriptions with "Sends …" or "Edits …"
Uses the description from the online documentation that can be translated while the current ones use the action name which makes it difficult to handle in other languages.
@NoRi2909 NoRi2909 marked this pull request as ready for review January 18, 2025 17:19
Copy link
Member

@andrewsayre andrewsayre 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!

@andrewsayre andrewsayre merged commit b32c401 into home-assistant:dev Jan 18, 2025
32 checks passed
@NoRi2909 NoRi2909 deleted the patch-914941 branch January 18, 2025 21:09
@github-actions github-actions bot locked and limited conversation to collaborators Jan 19, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants