lib/std: improve doc of the class `Path`
authorJean Privat <jean@pryen.org>
Mon, 20 Jul 2015 18:53:22 +0000 (14:53 -0400)
committerJean Privat <jean@pryen.org>
Tue, 21 Jul 2015 13:22:08 +0000 (09:22 -0400)
Signed-off-by: Jean Privat <jean@pryen.org>

lib/standard/file.nit

index 22a87b0..03a671e 100644 (file)
@@ -350,9 +350,13 @@ redef class Writable
        end
 end
 
-# Utility class to access file system services
+# Utility class to access file system services.
 #
 # Usually created with `Text::to_path`.
+#
+# `Path` objects does not necessarily represent existing files in a file system.
+# They are sate-less objects that efficiently represent path information.
+# They also provide an easy to use API on file-system services and are used to store their error status (see `last_error`)
 class Path
 
        private var path: String