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

(chore) Reference ConfigEntry consistently #511

Merged

Conversation

WebSpider
Copy link
Contributor

@WebSpider WebSpider commented Jan 2, 2025

This renames references to ConfigEntry from config to entry:

  • config is already used in relation to configurations of various climate entries
  • The naming was inconsistent, sometimes config, sometimes entry

Found this while working on #447 and it annoyed me 😁

@WebSpider WebSpider requested review from dvx76 and prvakt January 2, 2025 23:19
Copy link
Collaborator

@prvakt prvakt left a comment

Choose a reason for hiding this comment

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

question - is it not better to use config_entry instead entry/config ? It's unlikely to clash with other variables in future since it’s specific and from name its already clear that this object represents a ConfigEntry

@WebSpider
Copy link
Contributor Author

I chose entry because its in the HA example docs for integration development, but if we think config_entry is better, sure 👍

@prvakt
Copy link
Collaborator

prvakt commented Jan 3, 2025

I chose entry because its in the HA example docs for integration development, but if we think config_entry is better, sure 👍

I don't have a preference, so I'll leave the decision up to you :)

@prvakt prvakt self-requested a review January 3, 2025 10:58
@WebSpider WebSpider merged commit 165a4a1 into skodaconnect:main Jan 4, 2025
3 checks passed
@WebSpider WebSpider deleted the consistent-naming-configentry branch January 4, 2025 01:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants