bazelbuild/bazel

Documentation issue: C / C Rules -- I cannot parse meaning from `include_prefix`

クローズ

#12,043 opened on 2020/09/03

GitHub で見るコントリビューターガイド
 (2 件のコメント) (0 件のリアクション) (0 人の担当者)Java (4,465 件のフォーク)batch import
P3help wantedteam-Documentationteam-Rules-CPPtype: documentation (cleanup)

Repository metrics

Stars
 (25,384 個のスター)
PR merge metrics
 (平均マージ 22d 20h) (30d で 77 merged PRs)

説明

Documentation URL: https://docs.bazel.build/versions/master/be/c-cpp.html

From the documentation for include_prefix:

When set, the headers in the hdrs attribute of this rule are accessible at is the value of this attribute prepended to their repository-relative path.

I have read this sentence over and over again, but it mystifies me -- my brain gives up at "at is the value." I would offer a way to rephrase it to be less perplexing, but unfortunately I don't understand how include_prefix works because I can't understand the documentation for it. I'm stuck in a bit of a loop on this one.

コントリビューターガイド

調査方針
The issue is about the include prefix documentation at https://docs.bazel.build/versions/master/be/c cpp.html. The sentence 'When set, the headers in the `hdrs` attribute of this rule are accessible at is the value of this attribute prepended to their repository relative path.' is grammatically incorrect and confusing. The fix should rephrase the sentence to clearly explain how include prefix works, possibly by using examples or referencing standard patterns in Bazel documentation. See also the related discussion in the issue comments for additional context.
技術スタック
ccpp
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
古い
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
なし
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90