georust / rstar

R*-tree spatial index for the Rust ecosystem
https://docs.rs/rstar
Apache License 2.0
386 stars 67 forks source link

clarify MIN_SIZE constraints in docs #95

Closed michaelkirk closed 2 years ago

michaelkirk commented 2 years ago

Addendum to #93

Are these the docs that lead you astray in #92 @laundmo?

laundmo commented 2 years ago

If i understand #93 correctly the panic with a min-size of 1 is fixed. why does this require a docs change? the docs were clear before, just lacking the info that you couldn't use min-size 1.

urschrei commented 2 years ago

Because I added an additional check asserting that MIN_SIZE is greater than zero. This was implicit before, but with this change is both explicit and documented.

michaelkirk commented 2 years ago

bors r=rmanoka

bors[bot] commented 2 years ago

Build succeeded: