Skip to content

VectorBus - add methods to handle non message events#708

Merged
christiansandberg merged 8 commits intohardbyte:developfrom
zariiii9003:vector_handle_non_message_events
Nov 12, 2019
Merged

VectorBus - add methods to handle non message events#708
christiansandberg merged 8 commits intohardbyte:developfrom
zariiii9003:vector_handle_non_message_events

Conversation

@zariiii9003
Copy link
Collaborator

Add methods to handle vector driver events that are not caused by incoming messages. Can be implemented by subclassing.

I do not know if the docstrings are okay. sphinx-build doc/ doc/_build causes an error at reading sources... [ 16%] bus:
AttributeError: 'property' object has no attribute 'expandtabs'

@codecov
Copy link

codecov bot commented Oct 12, 2019

Codecov Report

Merging #708 into develop will increase coverage by 0.12%.
The diff coverage is 77.77%.

@@             Coverage Diff             @@
##           develop     #708      +/-   ##
===========================================
+ Coverage    68.44%   68.57%   +0.12%     
===========================================
  Files           69       69              
  Lines         6218     6227       +9     
===========================================
+ Hits          4256     4270      +14     
+ Misses        1962     1957       -5

Copy link
Collaborator

@christiansandberg christiansandberg left a comment

Choose a reason for hiding this comment

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

Since the methods are to be used outside of the library they should not be internal, i.e. remove the underscore from the beginning of the names.

@zariiii9003
Copy link
Collaborator Author

Hello Christian,
the methods are not really meant to be called from outside. They are called from within _recv_internal.
The user has to implement the methods though. Would you remove the underscore anyway?

@christiansandberg
Copy link
Collaborator

christiansandberg commented Nov 10, 2019

If they start with an underscore there is no guarantee that they will be called in future versions, which might break applications relying on their existence. If they are public, they need to be treated according to semantic versioning meaning backwards incompatible changes may only be introduced in a new major version.

@christiansandberg christiansandberg self-assigned this Nov 12, 2019
@christiansandberg christiansandberg added this to the 4.0 Release milestone Nov 12, 2019
@christiansandberg christiansandberg merged commit 3cf42bb into hardbyte:develop Nov 12, 2019
@zariiii9003 zariiii9003 deleted the vector_handle_non_message_events branch June 3, 2020 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants