diff --git a/documentation/commands/categories.md b/documentation/commands/categories.md index 85e9355de..237c23592 100644 --- a/documentation/commands/categories.md +++ b/documentation/commands/categories.md @@ -38,8 +38,8 @@ FLAG DESCRIPTIONS --version= 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= 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 ``` diff --git a/documentation/commands/docs.md b/documentation/commands/docs.md index 1ac3970f5..a5d3d567d 100644 --- a/documentation/commands/docs.md +++ b/documentation/commands/docs.md @@ -56,8 +56,8 @@ FLAG DESCRIPTIONS --version= 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= 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 ``` diff --git a/documentation/commands/openapi.md b/documentation/commands/openapi.md index 381e015e0..c5dc436a8 100644 --- a/documentation/commands/openapi.md +++ b/documentation/commands/openapi.md @@ -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= 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]` diff --git a/src/commands/openapi/index.ts b/src/commands/openapi/index.ts index 3d12fabe7..d216b58ae 100644 --- a/src/commands/openapi/index.ts +++ b/src/commands/openapi/index.ts @@ -58,7 +58,7 @@ export default class OpenAPICommand extends BaseCommand { }), 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.', }), }; diff --git a/src/lib/flags.ts b/src/lib/flags.ts index b3cf58336..a2240726e 100644 --- a/src/lib/flags.ts +++ b/src/lib/flags.ts @@ -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', });