bazelbuild/bazel

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

Fermée

#12 043 ouverte le 3 sept. 2020

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (0 personne assignée)Java (4 465 forks)batch import
P3help wantedteam-Documentationteam-Rules-CPPtype: documentation (cleanup)

Métriques du dépôt

Stars
 (25 384 étoiles)
Métriques de merge PR
 (Merge moyen 22j 20h) (77 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
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.
Stack technique
ccpp
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90