Skip to content

Commit e1ccb0e

Browse files
authored
docs: clarify behavior of name option [ci skip] (#389)
1 parent f13bc1b commit e1ccb0e

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/options/types.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,8 @@ export interface Options {
172172

173173
/**
174174
* The name to show in CLI output. This is useful for monorepos or workspaces.
175-
* Defaults to the package name from `package.json`.
175+
* When using workspace mode, this option defaults to the package name from package.json.
176+
* In non-workspace mode, this option must be set explicitly for the name to show in the CLI output.
176177
*/
177178
name?: string
178179

0 commit comments

Comments
 (0)