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

docs: remove a few redundant flag descriptions #1112

Merged
merged 1 commit into from
Dec 9, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs: remove a few redundant doc descriptions
kanadgupta committed Dec 9, 2024

Verified

This commit was signed with the committer’s verified signature.
kanadgupta Kanad Gupta
commit 87f223e88d2f4040346af271b0a7d88cd92614c0
8 changes: 4 additions & 4 deletions documentation/commands/categories.md
Original file line number Diff line number Diff line change
@@ -38,8 +38,8 @@ FLAG DESCRIPTIONS
--version=<value> ReadMe project version
Your ReadMe project version. If running command in a CI environment and this option is not passed, the main project
version will be used. See our docs for more information: https://docs.readme.com/main/docs/versions
If running command in a CI environment and this option is not passed, the main project version will be used. See our
docs for more information: https://docs.readme.com/main/docs/versions
```

## `rdme categories create TITLE`
@@ -87,6 +87,6 @@ FLAG DESCRIPTIONS
--version=<value> ReadMe project version
Your ReadMe project version. If running command in a CI environment and this option is not passed, the main project
version will be used. See our docs for more information: https://docs.readme.com/main/docs/versions
If running command in a CI environment and this option is not passed, the main project version will be used. See our
docs for more information: https://docs.readme.com/main/docs/versions
```
8 changes: 4 additions & 4 deletions documentation/commands/docs.md
Original file line number Diff line number Diff line change
@@ -56,8 +56,8 @@ FLAG DESCRIPTIONS
--version=<value> ReadMe project version
Your ReadMe project version. If running command in a CI environment and this option is not passed, the main project
version will be used. See our docs for more information: https://docs.readme.com/main/docs/versions
If running command in a CI environment and this option is not passed, the main project version will be used. See our
docs for more information: https://docs.readme.com/main/docs/versions
```

## `rdme docs prune FOLDER`
@@ -105,6 +105,6 @@ FLAG DESCRIPTIONS
--version=<value> ReadMe project version
Your ReadMe project version. If running command in a CI environment and this option is not passed, the main project
version will be used. See our docs for more information: https://docs.readme.com/main/docs/versions
If running command in a CI environment and this option is not passed, the main project version will be used. See our
docs for more information: https://docs.readme.com/main/docs/versions
```
7 changes: 3 additions & 4 deletions documentation/commands/openapi.md
Original file line number Diff line number Diff line change
@@ -108,13 +108,12 @@ FLAG DESCRIPTIONS
--update Bypasses the create/update prompt and automatically updates an existing API definition in ReadMe.
Bypasses the create/update prompt and automatically updates an existing API definition in ReadMe. Note that this
flag only works if there's only one API definition associated with the current version.
Note that this flag only works if there's only one API definition associated with the current version.
--version=<value> ReadMe project version
Your ReadMe project version. If running command in a CI environment and this option is not passed, the main project
version will be used. See our docs for more information: https://docs.readme.com/main/docs/versions
If running command in a CI environment and this option is not passed, the main project version will be used. See our
docs for more information: https://docs.readme.com/main/docs/versions
```

## `rdme openapi convert [SPEC]`
2 changes: 1 addition & 1 deletion src/commands/openapi/index.ts
Original file line number Diff line number Diff line change
@@ -58,7 +58,7 @@ export default class OpenAPICommand extends BaseCommand<typeof OpenAPICommand> {
}),
update: Flags.boolean({
description:
"Bypasses the create/update prompt and automatically updates an existing API definition in ReadMe. Note that this flag only works if there's only one API definition associated with the current version.",
"Note that this flag only works if there's only one API definition associated with the current version.",
summary: 'Bypasses the create/update prompt and automatically updates an existing API definition in ReadMe.',
}),
};
2 changes: 1 addition & 1 deletion src/lib/flags.ts
Original file line number Diff line number Diff line change
@@ -27,7 +27,7 @@ export const titleFlag = Flags.string({
*/
export const versionFlag = Flags.string({
description:
'Your ReadMe project version. If running command in a CI environment and this option is not passed, the main project version will be used. See our docs for more information: https://docs.readme.com/main/docs/versions',
'If running command in a CI environment and this option is not passed, the main project version will be used. See our docs for more information: https://docs.readme.com/main/docs/versions',
summary: 'ReadMe project version',
});