Skip to content

Commit

Permalink
glib: link to the Properties macro instead of mentioning Props
Browse files Browse the repository at this point in the history
It looks like `Props` in the internal name for `Properties`, but that's not
something a documentation reader should know about. Let's link to the macro's
documentation with the name a consumer of the library will use.
  • Loading branch information
carlosmn authored and bilelmoussaoui committed Jul 20, 2024
1 parent ca37e35 commit 4eea9a9
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions glib/src/property.rs
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,14 @@ impl<T: IsA<Object> + HasParamSpec> Property for SendWeakRef<T> {
}

// rustdoc-stripper-ignore-next
/// A container type implementing this trait can be read by the default getter generated by the `Props` macro.
/// A container type implementing this trait can be read by the default getter generated by the [`Properties`](crate::Properties) macro.
pub trait PropertyGet {
type Value;
fn get<R, F: Fn(&Self::Value) -> R>(&self, f: F) -> R;
}

// rustdoc-stripper-ignore-next
/// A container type implementing this trait can be written by the default setter generated by the `Props` macro.
/// A container type implementing this trait can be written by the default setter generated by the [`Properties`](crate::Properties) macro.
/// It takes a `FnOnce(&mut Self::Value)` so that the caller may access nested fields of a struct
/// by doing `${Self::Value}.member`
pub trait PropertySetNested {
Expand All @@ -77,7 +77,7 @@ pub trait PropertySetNested {
}

// rustdoc-stripper-ignore-next
/// A container type implementing this trait can be written by the default setter generated by the `Props` macro.
/// A container type implementing this trait can be written by the default setter generated by the [`Properties`](crate::Properties) macro.
pub trait PropertySet {
type SetValue;
fn set(&self, v: Self::SetValue);
Expand Down

0 comments on commit 4eea9a9

Please sign in to comment.