authorgravatar for scottschwarz77@hotmail.comScott Schwarz <scottschwarz77@hotmail.com> 2024-01-08 00:32:26-06:00
committergravatar for noreply@github.comGitHub <noreply@github.com> 2024-01-08 01:32:26-05:00
logf5978181e41e272b5c272440b9c543ead0357e2e
treea9562720a32c9b4fc23a765130a8bded96d968d1
parent3176fdc0b921b36ee7d8346ef302d0817b980cfa
signaturebadge-question-mark Signed by PGP key 4AEE18F83AFDEB23

langref: reword Hello World section (#18458)

closes #14347

1 files changed, 23 insertions(+), 26 deletions(-)

doc/langref.html.in+23-26
...@@ -432,18 +432,17 @@ pub fn main() !void {...@@ -432,18 +432,17 @@ pub fn main() !void {
432 </p>432 </p>
433 <p>433 <p>
434 Next, a {#link|public function|Functions#}, {#syntax#}pub fn{#endsyntax#}, named {#syntax#}main{#endsyntax#}434 Next, a {#link|public function|Functions#}, {#syntax#}pub fn{#endsyntax#}, named {#syntax#}main{#endsyntax#}
435 is declared. The {#syntax#}main{#endsyntax#} function is necessary because it tells the Zig compiler where the start of435 is declared. The {#syntax#}main{#endsyntax#} function is necessary because it tells the Zig compiler where the program starts. Programs
436 the program exists. Programs designed to be executed will need a {#syntax#}pub fn main{#endsyntax#} function.436 designed to be executed will need a {#syntax#}pub fn main{#endsyntax#} function.
437 </p>437 </p>
438 <aside role="note" aria-label="Note about main function">438 <aside role="note" aria-label="Note about main function">
439 <p>439 <p>
440 For more advanced use cases, Zig offers other features to inform the compiler where the start of440 For more advanced use cases, Zig offers other features to inform the compiler where the program starts. Also, libraries do not need a
441 the program exists. Also, libraries do not need a {#syntax#}pub fn main{#endsyntax#} function because441 {#syntax#}pub fn main{#endsyntax#} function because library code is called by other programs or libraries.
442 library code is called by other programs or libraries.
443 </p>442 </p>
444 </aside>443 </aside>
445 <p>444 <p>
446 A function is a block of any number of statements and expressions that, as a whole, perform a task.445 A function is a block of any number of statements and expressions, that as a whole, perform a task.
447 Functions may or may not return data after they are done performing their task. If a function446 Functions may or may not return data after they are done performing their task. If a function
448 cannot perform its task, it might return an error. Zig makes all of this explicit.447 cannot perform its task, it might return an error. Zig makes all of this explicit.
449 </p>448 </p>
...@@ -469,32 +468,30 @@ pub fn main() !void {...@@ -469,32 +468,30 @@ pub fn main() !void {
469 </aside>468 </aside>
470 <p>469 <p>
471 In Zig, a function's block of statements and expressions are surrounded by an open curly-brace <code>{</code> and470 In Zig, a function's block of statements and expressions are surrounded by an open curly-brace <code>{</code> and
472 close curly-brace <code>}</code>. Inside of the {#syntax#}main{#endsyntax#} function are expressions that perform471 close curly-brace <code>}</code>. In <code class="file">hello.zig</code>, the {#syntax#}main{#endsyntax#} function
473 the task of outputting <samp>Hello, world!</samp> to standard output.472 contains two statements.
474 </p>473 </p>
475 <p>474 <p>
476 First, a constant identifier, {#syntax#}stdout{#endsyntax#}, is initialized to represent standard output's475 In the first statement, a constant identifier, {#syntax#}stdout{#endsyntax#}, is initialized to represent standard output's
477 writer. Then, the program tries to print the <samp>Hello, world!</samp>476 writer. In the second statement, the program tries to print the <samp>Hello, world!</samp> message to standard output.
478 message to standard output.
479 </p>477 </p>
480 <p>478 <p>
481 Functions sometimes need information to perform their task. In Zig, information is passed479 Functions sometimes need inputs to perform their task. Inputs are passed, in between parentheses, to functions. These
482 to functions between an open parenthesis {#syntax#}({#endsyntax#} and a close parenthesis {#syntax#}){#endsyntax#} placed after480 inputs are also known as arguments. When multiple arguments are passed to a function, they are separated by commas.
483 the function's name. This information is also known as arguments. When there are
484 multiple arguments passed to a function, they are separated by commas {#syntax#},{#endsyntax#}.
485 </p>481 </p>
486 <p>482 <p>
487 The two arguments passed to the {#syntax#}stdout.print(){#endsyntax#} function, {#syntax#}"Hello, {s}!\n"{#endsyntax#}483 Two arguments are passed to the {#syntax#}stdout.print(){#endsyntax#} function: {#syntax#}"Hello, {s}!\n"{#endsyntax#}
488 and {#syntax#}.{"world"}{#endsyntax#}, are evaluated at {#link|compile-time|comptime#}. The code sample is484 and {#syntax#}.{"world"}{#endsyntax#}. The first argument is called a format string, which is a string containing one or
489 purposely written to show how to perform {#link|string|String Literals and Unicode Code Point Literals#}485 more placeholders. {#syntax#}"Hello, {s}!\n"{#endsyntax#} contains the placeholder {#syntax#}{s}{#endsyntax#}, which is
490 substitution in the {#syntax#}print{#endsyntax#} function. The curly-braces inside of the first argument486 replaced with {#syntax#}"world"{#endsyntax#} from the second argument. The file <code class="file">string_literals.zig</code> in
491 are substituted with the compile-time known value inside of the second argument487 {#link|String Literals and Unicode Code Point Literals|String Literals and Unicode Code Point Literals#} contains examples of format
492 (known as a {#link|tuple|Tuples#}). The <code>\n</code>488 strings that can be used with the {#syntax#}stdout.print(){#endsyntax#} function. The <code>\n</code> inside of
493 inside of the double-quotes of the first argument is the {#link|escape sequence|Escape Sequences#} for the489 {#syntax#}"Hello, {s}!\n"{#endsyntax#} is the {#link|escape sequence|Escape Sequences#} for the newline character.
494 newline character. The {#link|try#} expression evaluates the result of {#syntax#}stdout.print{#endsyntax#}.490 </p>
495 If the result is an error, then the {#syntax#}try{#endsyntax#} expression will return from491 <p>
496 {#syntax#}main{#endsyntax#} with the error. Otherwise, the program will continue. In this case, there are no492 The {#link|try#} expression evaluates the result of {#syntax#}stdout.print{#endsyntax#}. If the result is an error, then the
497 more statements or expressions left to execute in the {#syntax#}main{#endsyntax#} function, so the program exits.493 {#syntax#}try{#endsyntax#} expression will return from {#syntax#}main{#endsyntax#} with the error. Otherwise, the program will continue.
494 In this case, there are no more statements or expressions left to execute in the {#syntax#}main{#endsyntax#} function, so the program exits.
498 </p>495 </p>
499 <p>496 <p>
500 In Zig, the standard output writer's {#syntax#}print{#endsyntax#} function is allowed to fail because497 In Zig, the standard output writer's {#syntax#}print{#endsyntax#} function is allowed to fail because