[Documentation] Clarify BUILD file names
#18251
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The documentation currently refers to `BUILD` files with only a small side note that the may be called `BUILD.bazel`, namely where packages are defined. Instead, add a more prominent note to the page explaining `BUILD` files and clarify there that both namings are valid, that `BUILD.bazel` takes precendence, and that the documentation will talk just about `BUILD` files for simplicity's sake. Additionally, link to that page from the package definition section. Progress on bazelbuild#4517
saraadams
requested review from
gregestren,
philomathing and
fweikert
as code owners
github-actions
bot
added
awaiting-review
|
@laurentlb I know it's been a while since you expressed you're happy to review PRs to improve the documentation regarding this. Tagging you still. |
meteorcloudy
added
awaiting-PR-merge
sgowroji
removed
the
awaiting-PR-merge
fweikert
pushed a commit
to fweikert/bazel
that referenced
this pull request
May 25, 2023
The documentation currently refers to `BUILD` files with only a small side note that the may be called `BUILD.bazel`, namely where packages are defined. Instead, add a more prominent note to the page explaining `BUILD` files and clarify there that both namings are valid, that `BUILD.bazel` takes precendence, and that the documentation will talk just about `BUILD` files for simplicity's sake. Additionally, link to that page from the package definition section. Progress on bazelbuild#4517 Closes bazelbuild#18251. PiperOrigin-RevId: 529378158 Change-Id: If74903e0a9ffd4410a9c65c1fc9f3e5959fe83a7
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation currently refers to
BUILDfiles with only a small side note that the may be calledBUILD.bazel, namely where packages are defined.Instead, add a more prominent note to the page explaining
BUILDfiles and clarify there that both namings are valid, thatBUILD.bazeltakes precendence, and that the documentation will talk just aboutBUILDfiles for simplicity's sake. Additionally, link to that page from the package definition section.Progress on #4517