Skip to content

Commit

Permalink
docs: swap out summary and description whoops
Browse files Browse the repository at this point in the history
  • Loading branch information
kanadgupta committed Dec 11, 2024
1 parent a2b8b0b commit ce3ab6a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/lib/flags.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ export const githubFlag = Flags.boolean({ description: 'Create a new GitHub Acti
* Used in any command where `key` is a `flag.
*/
export const keyFlag = Flags.string({
description: 'ReadMe project API key',
summary: 'ReadMe project API key',
required: true,
summary:
description:
'An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v9#authentication',
});

Expand All @@ -26,9 +26,9 @@ export const titleFlag = Flags.string({
* Used in any command where `version` is a flag.
*/
export const versionFlag = Flags.string({
summary: 'ReadMe project version',
description:
'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',
});

/**
Expand Down

0 comments on commit ce3ab6a

Please sign in to comment.