bazelbuild / bazelbuild/bazel

Clarify language around labels and prefixes

Open
#13,032 4 comments 0 reactions 0 assignees View on GitHub
help wanted P3 team-Documentation team-ExternalDeps type: documentation (cleanup)
Dominant language
Java
Stars
25.8k
Forks
4.6k
Avg merge
2d 18h
Merged PRs (30d)
75

Description

Documentation URL: https://docs.bazel.build/versions/master/build-ref.html

Says:

> Labels start with `//`

But then goes on to say:

> the following "relative" labels are all equivalent:
> //my/app:app
> //my/app
> :app
> app

The last two don't start with `//`. So are they labels or not? Please clarify the text.

Contributor guide

Open the contributing guide

Research direction

Review the build-ref documentation at https://docs.bazel.build/versions/master/build-ref.html, focusing on the statements that labels start with // and that several relative forms are equivalent. Clarify the terminology so the relationship between labels, prefixes, and relative forms is unambiguous; the documentation is done when those quoted examples no longer appear contradictory.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.