v0.1.0

lpil · Nov 11, 2023 · b8659a8 · b8659a8
1 parent 1baadc6
commit b8659a8
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/filepath.gleam b/src/filepath.gleam
@@ -182,7 +182,8 @@ pub fn is_absolute(path: String) -> Bool {
 /// Expand `..` and `.` segments in a path.
 ///
 /// If the path has a `..` segment that would go up past the root of the path
-/// then an error is returned.
+/// then an error is returned. This may be useful to example to ensure that a
+/// path specified by a user does not go outside of a directory.
 ///
 /// If the path is absolute then the result will always be absolute.
 ///