docs - std.Io.Writer.print("{f}", .{})

[mike-git374]

Zig Version

0.16.0-dev.1204+389368392

Steps to Reproduce and Observed Behavior

I think the function signature on this line std/Io/Writer.zig#L589

should be:

fn (self: anytype, *Writer) Writer.Error!void

// or

fn (self: @This(), *Writer) Writer.Error!void

not:

fn (*Writer, args: anytype) Writer.Error!void

function is called here: std/Io/Writer.zig#L1050

Expected Behavior

docs

[squeek502]

Maybe

fn (@TypeOf(arg), *Writer) Writer.Error!void

or

fn (@TypeOf(value), *Writer) Writer.Error!void

?

[nektro]

it is described as a method so i think fn (*const T, *Writer) Writer.Error!void
or fn (*const @This(), *Writer) Writer.Error!void would be more clear to me

[squeek502]

@nektro not sure where the pointer comes into it, I believe defining the function like that would be a compile error unless the value was a *const T/*T. See std.fmt.Alt for one example without a pointer:

zig/lib/std/fmt.zig

Lines 266 to 277 in 73f863a

	/// Creates a type suitable for instantiating and passing to a "{f}" placeholder.
	pub fn Alt(
	comptime Data: type,
	comptime formatFn: fn (data: Data, writer: *Writer) Writer.Error!void,
	) type {
	return struct {
	data: Data,
	pub inline fn format(self: @This(), writer: *Writer) Writer.Error!void {
	try formatFn(self.data, writer);
	}
	};
	}

and an example usage of std.fmt.Alt:

zig/lib/std/unicode.zig

Lines 1486 to 1488 in 73f863a

	pub fn fmtUtf16Le(utf16le: []const u16) std.fmt.Alt([]const u16, formatUtf16Le) {
	return .{ .data = utf16le };
	}

which is used like so:

std.debug.print("{f}\n", .{std.unicode.fmtUtf16Le(slice)});