I previously started work on PR #3560, a plugin to allow the contents of a query to be tweeted - an admittedly niche use-case, but (I hoped) a useful introduction to contribution to the project.
I’ve returned to the code to provide tests & documentation so it may be included (assuming there is sufficient interest for me to do so). Using the flake8 linter (
tox -e lint) I’ve managed to correct most errors, however I am struggling to understand the need to address:
beetsplug/tweet.py:53:1: D107 Missing docstring in __init__ beetsplug/tweet.py:74:1: D102 Missing docstring in public method
All of the other plugin implementations I have checked do not provide a docstring for
__init__ on the plugin class or the
commands(...) function as these are standard & common, thus I don’t understand why my plugin file is raising these errors when others are not.
"tweet": ["twitter"], to
extras_require in case that would signify the file’s status as a plugin. Relatedly, for best practice I use
black to format all edited python files before saving which has raised another conflict with
setup.py:82:61: E231 missing whitespace after ',' setup.py:82:63: E231 missing whitespace after ',' setup.py:137:70: E231 missing whitespace after ','
I cannot see a reference to this error on discourse so I thought it may be worth bringing to general attention, as I understand there’s a PR to introduce
black as standard. My question from this would be do you recommend continuing to use
black for my code contribution, given its impending inclusion, or should I manually address these
flake8 errors (and disable
Thanks for all of your help in advance!