bazelbuild/bazel

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

Fechada

#12.043 aberto em 3 de set. de 2020

Ver no GitHubGuia do colaborador
 (2 comentários) (0 reação) (0 responsável)Java (4.465 forks)batch import
P3help wantedteam-Documentationteam-Rules-CPPtype: documentation (cleanup)

Métricas do repositório

Stars
 (25.384 estrelas)
Métricas de merge de PR
 (Mesclagem média 22d 20h) (77 fundiu PRs em 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.

Guia do colaborador

Direção de pesquisa
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.
Pilha de tecnologia
ccpp
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90