Skip to content

Commit c4d3ca1

Browse files
Apply suggestions from docs code review
Titles in sentence case, adding a hyphen to `command-line arguments` and styling Co-authored-by: Amy Reeve <amy.reeve@unity3d.com>
1 parent a6405ca commit c4d3ca1

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

com.unity.netcode.gameobjects/Documentation~/command-line-arguments.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,22 @@ Use [command-line arguments](https://docs.unity3d.com/Documentation/Manual/Comma
77
When launching a standalone build (such as a headless dedicated server), you can supply custom arguments to modify runtime behavior.
88

99
Reserved arguments:
10-
- -port
11-
- -ip
1210

13-
Unity provides built-in parsing for standard arguments, and you can extend this behavior by adding your own.
11+
- `-port`
12+
- `-ip`
1413

15-
---
14+
Unity provides built-in parsing for standard arguments, and you can extend this behavior by adding your own.
1615

17-
## Custom Arguments
16+
## Custom arguments
1817

19-
You can define additional custom command line arguments and retrieve them through the `CommandLineOptions` class.
20-
Use `GetArgs()` in your project code to collect and process these values.
18+
You can define additional custom command-line arguments and retrieve them through the `CommandLineOptions` class. Use `GetArgs()` in your project code to collect and process these values.
2119

22-
[!NOTE]
23-
Adding a custom command line argument requires you to explicitly retrieve and handle it in your implementation.
20+
> [!NOTE]
21+
> Adding a custom command-line argument requires you to explicitly retrieve and handle it in your implementation.
2422
25-
---
23+
## Example
2624

27-
## Example: Reading Command Line Arguments
25+
The following code shows you an example of defining and then reading a custom command-line argument.
2826
```
2927
private const string k_OverrideArg = "-argName";
3028
@@ -49,8 +47,6 @@ if (ParseCommandLineOptions(out var command))
4947
}
5048
```
5149

52-
---
53-
5450
## Override connection data
5551

5652
If you want to ignore the connection port provided through command-line arguments, you can override it by using the optional `forceOverride` parameter in:

0 commit comments

Comments
 (0)