Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed typos and improved uniformity of RNW CLI command help text #13386

Merged
merged 6 commits into from
Jun 27, 2024

Conversation

jonthysell
Copy link
Contributor

@jonthysell jonthysell commented Jun 25, 2024

Description

This PR fixes some typos in the help for RNW CLI commands.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)

Why

To clarify the CLI command options.

What

See above.

Screenshots

N/A

Testing

Nothing functional was changed.

Changelog

Should this change be included in the release notes: yes

Fixed typos and improved uniformity of RNW CLI command help text

Microsoft Reviewers: Open in CodeFlow

@jonthysell jonthysell requested review from a team as code owners June 25, 2024 21:55
| `--logging` | boolean | Verbose output logging |
| `--template` | string | Specify the template to use |
| `--name` | string | The native project name. Defaults to the name property in `app.json` or `package.json` |
| `--namespace` | string | The native project namespace, expressed using dots as separators, i.e. 'Level1.Level2.Level3'. Defaults to the same as name |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `--namespace` | string | The native project namespace, expressed using dots as separators, i.e. 'Level1.Level2.Level3'. Defaults to the same as name |
| `--namespace` | string | The native project namespace expressed using dots as separators, i.e. 'Level1.Level2.Level3'. Defaults to the same as name |

| Option | Input Type | Description |
|-----------------------|------------|--------------------------------------------------|
| `--release` | boolean | Specifies a Release build |
| `--root` | string | Override the root directory for the windows build which contains the windows folder (default: `E:\\test63`) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `--root` | string | Override the root directory for the windows build which contains the windows folder (default: `E:\\test63`) |
| `--root` | string | Override the root directory for the Windows build which contains the windows folder (default: `E:\\test63`) |

},
{
name: '--root [string]',
description:
'Override the root directory for the windows build which contains the windows folder.',
'Override the root directory for the windows build which contains the windows folder',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'Override the root directory for the windows build which contains the windows folder',
'Override the root directory for the Windows build which contains the windows folder',

Thanks Marlene!

Co-authored-by: Marlene Cota <[email protected]>
@jonthysell jonthysell enabled auto-merge (squash) June 26, 2024 18:57
@jonthysell jonthysell merged commit dbb8799 into microsoft:main Jun 27, 2024
57 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants