bazelbuild/bazel

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

已关闭

#12,043 创建于 2020年9月3日

在 GitHub 查看贡献者指南
 (2 条评论) (0 个反应) (0 位负责人)Java (4,465 个派生)batch import
P3help wantedteam-Documentationteam-Rules-CPPtype: documentation (cleanup)

仓库指标

星标
 (25,384 个星标)
PR 合并指标
 (平均合并 22天 20小时) (30 天内合并 77 个 PR)

描述

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
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
较久未更新
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90