search

mborsetti / webchanges

webchanges anonymously checks web content (including images) and commands for changes, delivering instant notifications and AI-powered summaries to your favorite platform.
https://pypi.org/project/webchanges/
Other
37 stars 6 forks source link

Documentation for diff #36

Closed ghost closed 2 years ago

ghost commented 2 years ago

I believe the example should be:

report: html: diff: table

 SyntaxWarning: Unrecognized directive(s) in the configuration file /Users/john/Library/Preferences/webchanges/config.yaml:
report:
  text:
    diff: table
Check for typos (documentation at https://webchanges.readthedocs.io/)
mborsetti commented 2 years ago

Thanks!!

Maybe the error text is not very clear, but it's trying to tell you that your config.yaml file has an additional directive that it doesn't know what to do with (i.e. you have diff: table inside the text reporter). This warning is to help users to catch inadvertent errors (maybe you intended to place it under the html reporter?).

If you have any suggestions on how to improve the warning text, it would be great!

ghost commented 2 years ago

Oh no. I was just showing what happens if a user follows the example. :)

On Apr 18, 2022, at 8:08 PM, Mike Borsetti @.***> wrote:

 Thanks!!

Maybe the error text is not very clear, but it's trying to tell you that your config.yaml file has an additional directive that it doesn't know what to do with (i.e. you have diff: table inside the text reporter). This warning is to help users to catch inadvertent errors (maybe you intended to place it under the html reporter?).

If you have any suggestions on how to improve the warning text, it would be great!

— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you authored the thread.

mborsetti commented 2 years ago

Oh, I didn't see the latest reply. I get it, and fixed the example for the next release.

Thanks for the report.