Skip to content

Commit

Permalink
Update references to docs in code comments and help output
Browse files Browse the repository at this point in the history
  • Loading branch information
mehulkar committed Jun 5, 2023
1 parent d2be602 commit 1b504de
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion cli/internal/core/engine.go
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ func (e *Engine) Prepare(options *EngineBuildingOptions) error {
}

// Filter down the tasks if there's a filter in place
// https: //turbo.build/repo/docs/reference/command-line-reference#--only
// https: //turbo.build/repo/docs/reference/command-line-reference/run#--only
if tasksOnly {
deps = deps.Filter(func(d interface{}) bool {
for _, target := range taskNames {
Expand Down
2 changes: 1 addition & 1 deletion cli/internal/scope/scope.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ var (
_filterHelp = `Use the given selector to specify package(s) to act as
entry points. The syntax mirrors pnpm's syntax, and
additional documentation and examples can be found in
turbo's documentation https://turbo.build/repo/docs/reference/command-line-reference#--filter
turbo's documentation https://turbo.build/repo/docs/reference/command-line-reference/run#--filter
--filter can be specified multiple times. Packages that
match any filter will be included.`
_ignoreHelp = `Files to ignore when calculating changed files (i.e. --since). Supports globs.`
Expand Down
2 changes: 1 addition & 1 deletion crates/turborepo-lib/src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,7 @@ pub struct RunArgs {
/// Use the given selector to specify package(s) to act as
/// entry points. The syntax mirrors pnpm's syntax, and
/// additional documentation and examples can be found in
/// turbo's documentation https://turbo.build/repo/docs/reference/command-line-reference#--filter
/// turbo's documentation https://turbo.build/repo/docs/reference/command-line-reference/run#--filter
#[clap(short = 'F', long, action = ArgAction::Append)]
pub filter: Vec<String>,
/// Ignore the existing cache (to force execution)
Expand Down
2 changes: 1 addition & 1 deletion packages/turbo-types/src/types/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ export interface Pipeline {
*
* "none": Hides all task output
*
* Documentation: https://turbo.build/repo/docs/reference/command-line-reference#--output-logs
* Documentation: https://turbo.build/repo/docs/reference/command-line-reference/run#--output-logs
*
* @default full
*/
Expand Down
2 changes: 1 addition & 1 deletion turborepo-tests/integration/tests/no_args.t
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Make sure exit code is 2 when no args are passed
--continue Continue execution even if a task exits with an error or non-zero exit code. The default behavior is to bail
--dry-run [<DRY_RUN>] [possible values: text, json]
--single-package Run turbo in single-package mode
-F, --filter <FILTER> Use the given selector to specify package(s) to act as entry points. The syntax mirrors pnpm's syntax, and additional documentation and examples can be found in turbo's documentation https://turbo.build/repo/docs/reference/command-line-reference#--filter
-F, --filter <FILTER> Use the given selector to specify package(s) to act as entry points. The syntax mirrors pnpm's syntax, and additional documentation and examples can be found in turbo's documentation https://turbo.build/repo/docs/reference/command-line-reference/run#--filter
--force [<FORCE>] Ignore the existing cache (to force execution) [env: TURBO_FORCE=] [possible values: true, false]
--framework-inference [<BOOL>] Specify whether or not to do framework inference for tasks [default: true] [possible values: true, false]
--global-deps <GLOBAL_DEPS> Specify glob of global filesystem dependencies to be hashed. Useful for .env and files
Expand Down
4 changes: 2 additions & 2 deletions turborepo-tests/integration/tests/turbo_help.t
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Test help flag
--continue Continue execution even if a task exits with an error or non-zero exit code. The default behavior is to bail
--dry-run [<DRY_RUN>] [possible values: text, json]
--single-package Run turbo in single-package mode
-F, --filter <FILTER> Use the given selector to specify package(s) to act as entry points. The syntax mirrors pnpm's syntax, and additional documentation and examples can be found in turbo's documentation https://turbo.build/repo/docs/reference/command-line-reference#--filter
-F, --filter <FILTER> Use the given selector to specify package(s) to act as entry points. The syntax mirrors pnpm's syntax, and additional documentation and examples can be found in turbo's documentation https://turbo.build/repo/docs/reference/command-line-reference/run#--filter
--force [<FORCE>] Ignore the existing cache (to force execution) [env: TURBO_FORCE=] [possible values: true, false]
--framework-inference [<BOOL>] Specify whether or not to do framework inference for tasks [default: true] [possible values: true, false]
--global-deps <GLOBAL_DEPS> Specify glob of global filesystem dependencies to be hashed. Useful for .env and files
Expand Down Expand Up @@ -112,7 +112,7 @@ Test help flag
--continue Continue execution even if a task exits with an error or non-zero exit code. The default behavior is to bail
--dry-run [<DRY_RUN>] [possible values: text, json]
--single-package Run turbo in single-package mode
-F, --filter <FILTER> Use the given selector to specify package(s) to act as entry points. The syntax mirrors pnpm's syntax, and additional documentation and examples can be found in turbo's documentation https://turbo.build/repo/docs/reference/command-line-reference#--filter
-F, --filter <FILTER> Use the given selector to specify package(s) to act as entry points. The syntax mirrors pnpm's syntax, and additional documentation and examples can be found in turbo's documentation https://turbo.build/repo/docs/reference/command-line-reference/run#--filter
--force [<FORCE>] Ignore the existing cache (to force execution) [env: TURBO_FORCE=] [possible values: true, false]
--framework-inference [<BOOL>] Specify whether or not to do framework inference for tasks [default: true] [possible values: true, false]
--global-deps <GLOBAL_DEPS> Specify glob of global filesystem dependencies to be hashed. Useful for .env and files
Expand Down

0 comments on commit 1b504de

Please sign in to comment.