Add some comments to explain what the differences between packages path and path/filepath

2 files changed, 7 insertions, 0 deletions

diff --git a/core/path/filepath/path.odin b/core/path/filepath/path.odin
index f2dbedf1f..283eb3a9e 100644
--- a/core/path/filepath/path.odin
+++ b/core/path/filepath/path.odin
@@ -1,3 +1,5 @@
+// The path/filepath package uses either forward slashes or backslashes depending on the operating system
+// To process paths usch as URLs that depend on forward slashes regardless of the OS, use the path package
 package filepath
 
 import "core:os"
diff --git a/core/path/path.odin b/core/path/path.odin
index 986d02d11..abdd213f9 100644
--- a/core/path/path.odin
+++ b/core/path/path.odin
@@ -1,3 +1,8 @@
+// The path package is only to be used for paths separated by forward slashes,

+// e.g. paths in URLs

+//

+// This package does not deal with Windows/NT paths with volume letters or backslashes

+// To manipulate operating system specific paths, use the path/filepath package

 package path

 

 import "core:strings"