zig

commit 2e7350140d4fbf9335e48693ccc4cba77d229c84 (tree)
parent 034ccb4e4e64dda2626535d46a4bc0367bcc1ad2
Author: Andrew Kelley <andrew@ziglang.org>
Date:   Sat, 30 Nov 2019 18:36:17 -0500

further clarify std.fs function docs

Diffstat:
M
lib/std/fs.zig
 | 
6
++++--

1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/lib/std/fs.zig b/lib/std/fs.zig
@@ -719,7 +719,8 @@ pub const Dir = struct {
         return File{ .handle = fd };
     }
 
-    /// Same as `openFile` but the path parameter is WTF-16 encoded.
+    /// Same as `openFile` but Windows-only and the path parameter is
+    /// [WTF-16](https://simonsapin.github.io/wtf-8/#potentially-ill-formed-utf-16) encoded.
     pub fn openFileW(self: Dir, sub_path_w: [*:0]const u16, flags: File.OpenFlags) File.OpenError!File {
         const w = os.windows;
         const access_mask = w.SYNCHRONIZE |
@@ -756,7 +757,8 @@ pub const Dir = struct {
         return File{ .handle = fd };
     }
 
-    /// Same as `createFile` but the path parameter is WTF-16 encoded.
+    /// Same as `createFile` but Windows-only and the path parameter is
+    /// [WTF-16](https://simonsapin.github.io/wtf-8/#potentially-ill-formed-utf-16) encoded.
     pub fn createFileW(self: Dir, sub_path_w: [*:0]const u16, flags: File.CreateFlags) File.OpenError!File {
         const w = os.windows;
         const access_mask = w.SYNCHRONIZE | w.GENERIC_WRITE |