bazelbuild / bazelbuild/bazel

Documentation issue: FeatureConfiguration

Open
#11,323 4 comments 0 reactions 0 assignees View on GitHub
help wanted P3 team-Documentation team-Rules-CPP type: documentation (cleanup)
Dominant language
Java
Stars
25.8k
Forks
4.6k
Avg merge
2d 20h
Merged PRs (30d)
72

Description

Documentation URL: https://docs.bazel.build/versions/master/skylark/lib/FeatureConfiguration.html

This documentation is missing any kind of detail of what a feature actually is. Also has no context of what CROSSTOOL is, or what a CROSSTOOL feature is.

This should be written to explain what a FeatureConfiguration actually represents rather than referring to implicit knowledge of the historical context of what a CROSSTOOL file was and what was defined in it.

Contributor guide

Open the contributing guide

Research direction

Start with the FeatureConfiguration documentation at the linked Documentation URL and identify the existing explanation and references to CROSSTOOL. Read the surrounding documentation to establish the intended audience and terminology. Done means the page explains what a feature and FeatureConfiguration represent, including the relevant CROSSTOOL context, without relying on historical implicit knowledge.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.