From 013f7fdd6e063386d085cca2962e0539c402f280 Mon Sep 17 00:00:00 2001
From: polazarus <polazarus@users.noreply.github.com>
Date: Sat, 7 Sep 2024 14:03:08 +0200
Subject: [PATCH] fix doc of `HipStr::borrowed`

fixes #28
---
 CHANGELOG.md  | 8 +++++++-
 src/bytes.rs  | 4 +++-
 src/string.rs | 4 +++-
 3 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index bb26c0b..8aca1f5 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 Notable changes only.
 
+## [unreleased]
+
+### Fixed
+
+- fix doc issue [#28](https://github.com/polazarus/hipstr/issues/28)
+
 ## [0.5.1] - 2024-08-02
 
 ### Added
@@ -110,7 +116,7 @@ Most of those addition are breaking because they shadows `str`'s methods.
 
 Initial release
 
-<!-- [unreleased]: https://github.com/polazarus/hipstr/compare/0.5.1...HEAD -->
+[unreleased]: https://github.com/polazarus/hipstr/compare/0.5.1...HEAD
 [0.5.1]: https://github.com/polazarus/hipstr/compare/0.5.0...0.5.1
 [0.5.0]: https://github.com/polazarus/hipstr/compare/0.4.0...0.5.0
 [0.4.0]: https://github.com/polazarus/hipstr/compare/0.3.3...0.4.0
diff --git a/src/bytes.rs b/src/bytes.rs
index 9dc21e5..7d34267 100644
--- a/src/bytes.rs
+++ b/src/bytes.rs
@@ -128,7 +128,9 @@ where
         Self(Raw::with_capacity(cap))
     }
 
-    /// Creates a new `HipByt` from a borrowed slice without copying the slice.
+    /// Creates a new `HipByt` from a byte slice.
+    /// No heap allocation is performed.
+    /// **The slice is not copied.**
     ///
     /// # Examples
     ///
diff --git a/src/string.rs b/src/string.rs
index b13b14d..c200b36 100644
--- a/src/string.rs
+++ b/src/string.rs
@@ -116,7 +116,9 @@ where
         Self(HipByt::with_capacity(cap))
     }
 
-    /// Creates a new `HipStr` from a static string slice without copying the slice.
+    /// Creates a new `HipStr` from a string slice.
+    /// No heap allocation is performed.
+    /// **The string is not copied.**
     ///
     /// # Examples
     ///