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

Doc fix: a circular dependency does not raise an error. #18298

Merged
merged 1 commit into from Nov 8, 2018

Conversation

Projects
None yet
3 participants
@smurfix
Contributor

smurfix commented Nov 7, 2018

This is easier to handle than raising an exception: a circular
dependency causes multiple error entries in the log, which is what we
want.

This is harder to achieve with an exception. Since there is only one
user of this code, I choose to fix the documentation -- instead of
adding a lot of mostly-useless exception handling.

Closes: #13147

Checklist:

  • The code change is tested and works locally.

  • Local tests pass with tox. Your PR cannot be merged unless tests pass

  • There is no commented out code in this PR.

  • Tests to verify that the code works already exist.

Doc fix: a circular dependency does not raise an error.
This is easier to handle than raising an exception: a circular
dependency causes multiple error entries in the log, which is what we
want.

This is harder to achieve with an exception. Since there is only one
user of this code, I choose to fix the documentation -- instead of
adding a lot of mostly-useless exception handling.

Closes: #13147

@smurfix smurfix requested a review from home-assistant/core as a code owner Nov 7, 2018

@wafflebot wafflebot bot added the in progress label Nov 7, 2018

@balloob

balloob approved these changes Nov 8, 2018

@balloob

This comment has been minimized.

Member

balloob commented Nov 8, 2018

Looks good.

@balloob balloob merged commit 9472529 into home-assistant:dev Nov 8, 2018

5 checks passed

Hound No violations found. Woof!
WIP ready for review
Details
cla-bot Everyone involved has signed the CLA
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls First build on circular at 93.043%
Details

@wafflebot wafflebot bot removed the in progress label Nov 8, 2018

@balloob

This comment has been minimized.

Member

balloob commented Nov 8, 2018

About issues not getting answers, there is too much happening and things get regularly lost. Given the time every person has, it's something we have to accept that happens.

@smurfix

This comment has been minimized.

Contributor

smurfix commented Nov 8, 2018

Not a problem, if it's anything important I'll simply prod again. ;-)

@balloob

This comment has been minimized.

Member

balloob commented Nov 8, 2018

Yes please. If it's security or performance in core related, feel free to escalate directly to me and tag me.

zxdavb added a commit to zxdavb/home-assistant that referenced this pull request Nov 13, 2018

Doc fix: a circular dependency does not raise an error. (home-assista…
…nt#18298)

This is easier to handle than raising an exception: a circular
dependency causes multiple error entries in the log, which is what we
want.

This is harder to achieve with an exception. Since there is only one
user of this code, I choose to fix the documentation -- instead of
adding a lot of mostly-useless exception handling.

Closes: home-assistant#13147

@balloob balloob referenced this pull request Nov 29, 2018

Merged

0.83 #18776

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment