Deprecate CLOSE_COMM_ON_ERROR

[janiversen]

Breaking change

"close_comm_on_error:" is no optional, sockets will always be closed on error, therefor it is now deprecated, and will be removed in 2024.3.

Proposed change

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:
  Deprecate close_comm_on_error. home-assistant.io#28853

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 Black (black --fast homeassistant tests)
• Tests have been added to verify that the new code works.

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

• Documentation added/updated for www.home-assistant.io

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.
• Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[home-assistant]

Hey there @adamchengtkc, @vzahradnik, mind taking a look at this pull request as it has been labeled with an integration (modbus) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of modbus can trigger bot actions by commenting:

• @home-assistant close Closes the pull request.
• @home-assistant rename Awesome new title Renames the pull request.
• @home-assistant reopen Reopen the pull request.
• @home-assistant unassign modbus Removes the current integration label and assignees on the pull request, add the integration domain after the command.

[home-assistant]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

[gjohansson-ST]

@janiversen need a linked PR for docs to remove the close_comm_on_error option from the configuration YAML and the examples.

[janiversen]

@gjohansson-ST thanks, documentation PR is added.

[gjohansson-ST]

Thanks @janiversen 👍

Comments addressed

[janiversen]

@gjohansson-ST, @joostlek thanks, this was a lot of small changes in a short time, but I learned to make issues...which I will integrate deeper into the code when people use conflicting parameters.

[joostlek]

It's a very user friendly way of giving instructions that they should change something. The clearer the message gets, the more people know how to deal with it and so they create less issues :D