DOC: Clarification in doc of intersects

[theroggy]

New pull request to test the readthedocs integration for pull requests.

Apparently the pull request has to be created after the readthedocs integration became active, so #1861 cannot be used to test it anymore.

[sgillies]

@theroggy I like your change, it's more clear. For the sake of completeness, can you restore the mention of overlaps and within?

[theroggy]

@theroggy I like your change, it's more clear. For the sake of completeness, can you restore the mention of overlaps and within?

@sgillies I didn't keep that phrase because I'm not sure what is meant by it.

My interpretation would be that literally all of them (overlaps, within and touches) need to be True for intersects to be True, which is not the case. Even one of them having to be True is not the case, e.g. in the example below intersects is True but all of the other predicates are False.

So, I'm not sure how to interprete it and/or how to rephrase it.

import shapely

poly1 = shapely.Polygon([(0,0), (10,0), (10,10), (0,10), (0,0)])
poly2 = shapely.Polygon([(0,0), (5,0), (5,10), (0,5), (0,0)])

print(f"intersects: {shapely.intersects(poly1, poly2)}")
print(f"touches: {shapely.touches(poly1, poly2)}")
print(f"within: {shapely.within(poly1, poly2)}")
print(f"overlaps: {shapely.overlaps(poly1, poly2)}")

prints:

intersects: True
touches: False
within: False
overlaps: False