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
Document and rationalise worker interface #48
Conversation
Codecov Report
@@ Coverage Diff @@
## master #48 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 24 24
Lines 1667 1666 -1
=========================================
- Hits 1667 1666 -1
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good, small typo I noticed.
Is moving most of the variables in the worker to private just for a cleaner interface to users? Honestly the functions being called with private
looks a bit funny to me (and self
but to a lesser extent). Feels like if those properties need to be accessed then they should be available as public properties. I see why though, I think none of the functions which take private
are called from outside the function? So really just using it as a way to break up the code in the object. Perhaps that suggests though that the object is managing too many concerns and it might be worth breaking it up into several objects. At least that is what you would have to do in something like java but perhaps because we can pass around private
it is fine - the code isn't difficult to understand. I think fine as is but maybe something to discuss as a general pattern.
Co-authored-by: Rob <39248272+r-ash@users.noreply.github.com>
This became necessary when writing the docs