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

[BUG] A possible error in the docs #44

Closed drws closed 2 years ago

drws commented 2 years ago

Describe the bug Here in the docs it says that

job_defaults:
  all:
    headers:

is the right structure to set HTTP headers globally, but here it says otherwise:

job_defaults:
  url:
    headers:

Which is the correct one?

mborsetti commented 2 years ago

Thanks for reporting this!

It will get fixed in the next release.

For now you can refer to the the information here explaining the difference between url and all (which, in the case of headers, would apply the default to both url and browser as they are the only job types consuming headers).

drws commented 2 years ago

Thanks for clearing that up. I've just found another inconsistency - between 1 and 2. show_details and show_footer vs. details and footer.

mborsetti commented 2 years ago

Thank you for your feedback; very much appreciated!

mborsetti commented 2 years ago

Release 3.11 is out with your suggested fixes. Thank you very much for taking the time to report this!