Add some references to make StrMatcherConfigurator more discoverable.

Previously, finding this extension trait and its methods would require navigating manually through the documentation, which made nearly impossible to discover. These references call out specifically that one can use this trait to configure matching of strings in places where one constructs matchers which can be configued by it.

PiperOrigin-RevId: 527889895

Author: hovinenb

googletest/src/matchers/eq_matcher.rs

@@ -37,7 +37,7 @@ use std::{fmt::Debug, marker::PhantomData};
 /// ```
 ///
 /// `expected` to `actual` must be comparable with one another via the
-/// `PartialEq` trait. In most cases, this means that they must be of the same
+/// [`PartialEq`] trait. In most cases, this means that they must be of the same
 /// type. However, there are a few cases where different but closely related
 /// types are comparable, for example `String` with `&str`.
 ///
@@ -65,8 +65,10 @@ use std::{fmt::Debug, marker::PhantomData};
 /// verify_that(actual, eq(&expected))?; // Compiles
 /// ```
 ///
-/// You can find the standard library PartialEq implementation in
-/// <https://doc.rust-lang.org/core/cmp/trait.PartialEq.html#implementors>
+/// When matching with string types (`&str` and `String`), one can set more
+/// options on how equality is checked through the
+/// [`StrMatcherConfigurator`][crate::matchers::str_matcher::StrMatcherConfigurator]
+/// extension trait, which is implemented for this matcher.
 pub fn eq<A: ?Sized, T>(expected: T) -> EqMatcher<A, T> {
     EqMatcher { expected, phantom: Default::default() }
 }

googletest/src/matchers/str_matcher.rs

@@ -48,6 +48,9 @@ use std::ops::Deref;
 /// # should_pass_2().unwrap();
 /// ```
 ///
+/// See the [`StrMatcherConfigurator`] extension trait for more options on how
+/// the string is matched.
+///
 /// > Note on memory use: In most cases, this matcher does not allocate memory
 /// > when matching strings. However, it must allocate copies of both the actual
 /// > and expected values when matching strings while
@@ -90,6 +93,9 @@ pub fn contains_substring<A: ?Sized, T>(expected: T) -> StrMatcher<A, T> {
 /// # should_fail_2().unwrap_err();
 /// # should_pass_2().unwrap();
 /// ```
+///
+/// See the [`StrMatcherConfigurator`] extension trait for more options on how
+/// the string is matched.
 pub fn starts_with<A: ?Sized, T>(expected: T) -> StrMatcher<A, T> {
     StrMatcher {
         configuration: Configuration { mode: MatchMode::StartsWith, ..Default::default() },
@@ -127,6 +133,9 @@ pub fn starts_with<A: ?Sized, T>(expected: T) -> StrMatcher<A, T> {
 /// # should_fail_2().unwrap_err();
 /// # should_pass_2().unwrap();
 /// ```
+///
+/// See the [`StrMatcherConfigurator`] extension trait for more options on how
+/// the string is matched.
 pub fn ends_with<A: ?Sized, T>(expected: T) -> StrMatcher<A, T> {
     StrMatcher {
         configuration: Configuration { mode: MatchMode::EndsWith, ..Default::default() },
@@ -135,11 +144,11 @@ pub fn ends_with<A: ?Sized, T>(expected: T) -> StrMatcher<A, T> {
     }
 }
 
-/// Extension trait to configure [StrMatcher].
+/// Extension trait to configure [`StrMatcher`].
 ///
 /// Matchers which match against string values and, through configuration,
-/// specialise to [StrMatcher] implement this trait. Currently that only
-/// includes [EqMatcher] and [StrMatcher].
+/// specialise to [`StrMatcher`] implement this trait. That includes
+/// [`EqMatcher`] and [`StrMatcher`].
 pub trait StrMatcherConfigurator<ActualT: ?Sized, ExpectedT> {
     /// Configures the matcher to ignore any leading whitespace in either the
     /// actual or the expected value.