[traits] rename CoordTrait::nth_unchecked -> nth_or_panic to match conventional semantics #1242
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michaelkirk
force-pushed
the
mkirk/trait-coord-nth-or-panic
branch
from
a080163 to
bc5815e
Compare
kylebarron
approved these changes
Oct 30, 2024
2 tasks
frewsxcv
approved these changes
Oct 30, 2024
|
I've restored Please take another look. |
michaelkirk
commented
Oct 30, 2024
| /// | ||
| /// See also [`nth_or_panic()`](Self::nth_or_panic) and [`nth_unchecked()`](Self::nth_unchecked). | ||
| /// | ||
| /// # Panics |
There was a problem hiding this comment.
Added a panic condition.
frewsxcv
approved these changes
Oct 30, 2024
kylebarron
approved these changes
Oct 30, 2024
michaelkirk
force-pushed
the
mkirk/trait-coord-nth-or-panic
branch
from
20a6db5 to
d6d357d
Compare
…nventional semantics `unchecked` implies it's an unsafe method, like `Vec::get_unsafe` Also cleaned up some stale docs.
michaelkirk
force-pushed
the
mkirk/trait-coord-nth-or-panic
branch
from
d6d357d to
8fa9776
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
CHANGES.mdif knowledge of this change could be valuable to users.uncheckedimplies it's an unsafe method, likeVec::get_unsafe. It's how we use the term elsewhere in this api, e.g. see this discussion georust/geojson#245 (comment)I also cleaned up some stale docs.
I opted not to add
foo_or_panicmethods to the various collections in this PR, as it seemed like a slightly different issue that could be followed up separately.