e-alizadeh / Zotero2Readwise

A Python Library to retrieve annotations and notes from Zotero and upload them to your Readwise.
MIT License
131 stars 24 forks source link

run.py -h says notes are included by default by they aren't #74

Closed cabahrdtnet closed 7 months ago

cabahrdtnet commented 8 months ago

When running run.py -h in version 0.4.4, run.py tells users that notes are included by default. However, they are not.

The reason for this is simply that the help parameter for the corresponding argument says so: help="Include Zotero notes | Options: 'y'/'yes' (default), 'n'/'no'", Line 36 of run.py at 18715da

But the default parameter is set to 'n': default="n", Line 35 of run.py at 18715da

As I am a rather new user of Zotero2Readwise, I can only assume I would have expected a default="y" here, so that the user isn't surprised that certain data has not been exported to Readwise. But, if this is a deliberate choice, then the help string should be adapted.

e-alizadeh commented 7 months ago

Thanks @cabahrdtnet for raising this issue. I've updated the help. FYI, the default argument is set to n, so the default setting does not include annotations unless specifically asked to be included.

cabahrdtnet commented 7 months ago

You're most welcome, thanks for fixing this.