You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
std lib example: file:///home/andy/dev/zig/build/zig-cache/docs/index.html#std;io.readFileAlloc (I recognize this is a file:/// URL; we don't have #3402 done yet)
when a parameter name is its type name lower cased, the parameter name is omitted.
This is a great idea! Sometimes the type is documentation enough about how to use a certain parameter. Especially for something like *std.mem.Allocator the use in the Zig language is quite clear and thus removes clutter from the documentation.
std lib example:
file:///home/andy/dev/zig/build/zig-cache/docs/index.html#std;io.readFileAlloc
(I recognize this is a file:/// URL; we don't have #3402 done yet)it shows:
but it should show:
I would also like to propose the following rule:
That would further adjust the expected docs to be:
The text was updated successfully, but these errors were encountered: