doc(emath): Add top_left as an alias for left_top, etc.
#4689
Conversation
This file contains 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
Extremely minor annoyance, but I keep getting confused by this as "top left" is much more natural in english.
emilk
approved these changes
Jun 23, 2024
emilk
added
docs and examples
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.
What
Adds
#[doc(alias = "top_left")]as an alias forleft_top, and so on forright_top,right_bottom,left_bottom.Why
Extremely minor doc-only change, but I keep going to type "top left" to look for the top left of a rectangle.
I'm unsure whether this is just a british-english thing or an english-in-general thing, but
top left corneris far more common thanleft top corner.These doc aliases don't conflict with anything, and mean that rust-analyzer will suggest the correct function when I search for the wrong thing.
This improves ergonomics and discoverability in my opinion, even if not by much.