bazelbuild / bazelbuild/bazel

Documentation issue: Depsets This page content belongs in a different place

Open
#13,539 2 comments 0 reactions 0 assignees View on GitHub
P2 team-Documentation team-Starlark-Integration type: documentation (cleanup)
Dominant language
Java
Stars
25.8k
Forks
4.6k
Avg merge
2d 18h
Merged PRs (30d)
75

Description

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

There are two problems.
1. This page has vital information about using the API. Specifically, how to construct a depset. It belong in the page where the API is described. https://docs.bazel.build/versions/master/skylark/lib/depset.html

2. Neither of the pages belong under .../skylark/. Depsets are not a Starlark feature, they are Bazel specific. It belongs in a "rule writing" section, which is not present in the current sidebar navigation.

Contributor guide

Open the contributing guide

Research direction

Start by comparing the depsets page at https://docs.bazel.build/versions/master/skylark/depsets.html with the API page at https://docs.bazel.build/versions/master/skylark/lib/depset.html, then inspect the current sidebar navigation. Done means the construction guidance is placed with the API and both pages are organized under an appropriate Bazel rule-writing section rather than the Starlark section.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.