Merge pull request #25875 from Zirunis/patch-2

Update Style Guide to suggest TitleCase for Type aliases as is the reality in the standard library
This commit is contained in:
Ryan Liptak 2025-11-09 22:40:24 -08:00 committed by GitHub
commit c58687225b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -7105,10 +7105,12 @@ coding style.
</p> </p>
<ul> <ul>
<li> <li>
If {#syntax#}x{#endsyntax#} is a {#syntax#}type{#endsyntax#} If {#syntax#}x{#endsyntax#} is a {#syntax#}struct{#endsyntax#} with 0 fields and is never meant to be instantiated
then {#syntax#}x{#endsyntax#} should be {#syntax#}TitleCase{#endsyntax#}, unless it then {#syntax#}x{#endsyntax#} is considered to be a "namespace" and should be {#syntax#}snake_case{#endsyntax#}.
is a {#syntax#}struct{#endsyntax#} with 0 fields and is never meant to be instantiated, </li>
in which case it is considered to be a "namespace" and uses {#syntax#}snake_case{#endsyntax#}. <li>
If {#syntax#}x{#endsyntax#} is a {#syntax#}type{#endsyntax#} or {#syntax#}type{#endsyntax#} alias
then {#syntax#}x{#endsyntax#} should be {#syntax#}TitleCase{#endsyntax#}.
</li> </li>
<li> <li>
If {#syntax#}x{#endsyntax#} is callable, and {#syntax#}x{#endsyntax#}'s return type is If {#syntax#}x{#endsyntax#} is callable, and {#syntax#}x{#endsyntax#}'s return type is
@ -7147,8 +7149,7 @@ const namespace_name = @import("dir_name/file_name.zig");
const TypeName = @import("dir_name/TypeName.zig"); const TypeName = @import("dir_name/TypeName.zig");
var global_var: i32 = undefined; var global_var: i32 = undefined;
const const_name = 42; const const_name = 42;
const primitive_type_alias = f32; const PrimitiveTypeAlias = f32;
const string_alias = []u8;
const StructName = struct { const StructName = struct {
field: i32, field: i32,