Skip to content

[docs-scanner] Time-relative language in Bake targets documentation #24516

@docker-agent

Description

@docker-agent

File: content/manuals/build/bake/targets.md

Issue

The "Pattern matching for targets and groups" section uses time-relative language:

Always wrap wildcard patterns in quotes. Without quotes, your shell will expand the
wildcard to match files in the current directory, which usually causes errors.

The word "usually" is a hedge word that suggests uncertainty about when errors occur. According to STYLE.md, hedge words like "usually" should be avoided as they overstate or understate behavior.

Suggested fix

Be more specific about when errors occur:

Always wrap wildcard patterns in quotes. Without quotes, your shell will expand the
wildcard to match files in the current directory, which causes errors if those files
don't match valid targets.

Or, if it always causes errors:

Always wrap wildcard patterns in quotes. Without quotes, your shell will expand the
wildcard to match files in the current directory, causing errors.

This removes the hedge word and provides clearer guidance about the actual behavior.


Found by nightly documentation freshness scanner

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions