📝 Enhance documentation comment for EntryName and EntryReference

ChanTsune · Aug 11, 2024 · 432b3c2 · 432b3c2
1 parent e962cf7
commit 432b3c2
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/lib/src/entry/name.rs b/lib/src/entry/name.rs
@@ -217,6 +217,13 @@ impl PartialEq<str> for EntryName {
 }
 
 impl PartialEq<&str> for EntryName {
+    /// # Examples
+    ///
+    /// ```
+    /// use libpna::EntryName;
+    ///
+    /// assert_eq!(EntryName::from("test.txt"), "test.txt");
+    /// ```
     #[inline]
     fn eq(&self, other: &&str) -> bool {
         PartialEq::eq(self.as_str(), *other)
@@ -231,6 +238,13 @@ impl PartialEq<EntryName> for str {
 }
 
 impl PartialEq<EntryName> for &str {
+    /// # Examples
+    ///
+    /// ```
+    /// use libpna::EntryName;
+    ///
+    /// assert_eq!("test.txt", EntryName::from("test.txt"));
+    /// ```
     #[inline]
     fn eq(&self, other: &EntryName) -> bool {
         PartialEq::eq(self, &other.as_str())

diff --git a/lib/src/entry/reference.rs b/lib/src/entry/reference.rs
@@ -218,6 +218,13 @@ impl PartialEq<str> for EntryReference {
 }
 
 impl PartialEq<&str> for EntryReference {
+    /// # Examples
+    ///
+    /// ```
+    /// use libpna::EntryReference;
+    ///
+    /// assert_eq!(EntryReference::from("test.txt"), "test.txt");
+    /// ```
     #[inline]
     fn eq(&self, other: &&str) -> bool {
         PartialEq::eq(self.as_str(), *other)
@@ -232,6 +239,13 @@ impl PartialEq<EntryReference> for str {
 }
 
 impl PartialEq<EntryReference> for &str {
+    /// # Examples
+    ///
+    /// ```
+    /// use libpna::EntryReference;
+    ///
+    /// assert_eq!("test.txt", EntryReference::from("test.txt"));
+    /// ```
     #[inline]
     fn eq(&self, other: &EntryReference) -> bool {
         PartialEq::eq(self, &other.as_str())