urlstechie / urlchecker-python

:snake: :link: Python module and client for checking URLs
https://urlchecker-python.readthedocs.io
MIT License
20 stars 12 forks source link

Clarification on exclude_patterns #60

Open shyndman opened 2 years ago

shyndman commented 2 years ago

Hi there,

I was playing around with your library, and had to dig into your code to see how exclude patterns work. I think I understand correctly that they're substrings (not glob/regex) that can appear in a URL to exclude it from consideration.

Might I suggest that their format and use is clarified in the docs?

vsoch commented 2 years ago

Sure! That would be very helpful! If you’d like to submit a PR I would also be happy to give you credit for a Hacktoberfest contribution.

shyndman commented 2 years ago

Sure, happy to. Give me a few.

shyndman commented 2 years ago

OK, I'm in it. I'm finding a few inconsistencies. Mind if I do a bit of surgery, now that I'm in here?

vsoch commented 2 years ago

go for it!