skyler
/
egui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc(emath): Add `top_left` as an alias for `left_top`, etc. (#4689) 

# What

Adds `#[doc(alias = "top_left")]` as an alias for `left_top`, and so on
for `right_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 corner` is far more common than
`left 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.
This commit is contained in:
zkldi 2024-06-23 10:50:35 +01:00 committed by GitHub
parent d7ccf4d341
commit 8cef6fc872
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
crates/emath/src/rect.rs
View File

@ -565,6 +565,7 @@ impl Rect {
}
#[inline(always)]
#[doc(alias = "top_left")]
pub fn left_top(&self) -> Pos2 {
pos2(self.left(), self.top())
}
@ -575,6 +576,7 @@ impl Rect {
}
#[inline(always)]
#[doc(alias = "top_right")]
pub fn right_top(&self) -> Pos2 {
pos2(self.right(), self.top())
}
@ -590,6 +592,7 @@ impl Rect {
}
#[inline(always)]
#[doc(alias = "bottom_left")]
pub fn left_bottom(&self) -> Pos2 {
pos2(self.left(), self.bottom())
}
@ -600,6 +603,7 @@ impl Rect {
}
#[inline(always)]
#[doc(alias = "bottom_right")]
pub fn right_bottom(&self) -> Pos2 {
pos2(self.right(), self.bottom())
}