bazelbuild/bazel

Documentation Issue: FeatureConfiguration docs should cover construction

Open

#14,774 opened on Feb 9, 2022

View on GitHub
 (0 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

Some cc_common APIs require a FeatureConfiguration, but the docs for this type have no info about how those are created

https://docs.bazel.build/versions/main/skylark/lib/FeatureConfiguration.html

Even though the creation isn't done by this type directly it would be useful if the docs linked to the relevant docs for creating these such as

https://docs.bazel.build/versions/main/skylark/lib/cc_common.html#configure_features

Contributor guide

Research direction
Add a link to the cc common.configure features documentation in the FeatureConfiguration documentation page.
Tech stack
java
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitBazel
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85