bazelbuild/bazel

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

Closed

#12,043 opened on Sep 3, 2020

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Java (4,465 forks)batch import
P3help wantedteam-Documentationteam-Rules-CPPtype: documentation (cleanup)

Repository metrics

Stars
 (25,384 stars)
PR merge metrics
 (Avg merge 22d 20h) (77 merged PRs in 30d)

Description

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.

Contributor guide

Research direction
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.
Tech stack
ccpp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90