Improve clarity of error messages / docs w.r.t. "BUILD" vs "BUILD.bazel" #17054
Labels
not stale
Issues or PRs that are inactive but not considered stale
P4
This is either out of scope or we don't have bandwidth to review a PR. (No assignee)
team-Loading-API
BUILD file and macro processing: labels, package(), visibility, glob
type: feature request
Motivation is improving error messages like in #16207, so that users of repos that follow the "BUILD.bazel" convention aren't misled into thinking they need to create a file named "BUILD". (We also have the opposite problem within Google: We wouldn't necessarily want to direct users to create "BUILD.bazel" files when our monorepo exclusively uses "BUILD".)
We could pedantically mention "BUILD or BUILD.bazel" everywhere in errors an documentation, but that could get cumbersome and probably isn't worth its weight to the reader. Alternatively, we could just decide to only ever call them by one name or the other, and ensure the glossary or other concept documentation explains that this is an abbreviated form.
The text was updated successfully, but these errors were encountered: