bazelbuild / bazelbuild/bazel

Documentation issue: Type of keys+values of ctx.runfiles's symlinks dict is unclear

Open
#11,724 4 comments 0 reactions 0 assignees View on GitHub
P3 team-Documentation team-Rules-API 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/2.0.0/skylark/lib/ctx.html#runfiles

> Parameter | Description
> -- | --
> `symlinks` | `dict` The map of symlinks to be added to the runfiles, prefixed by workspace name.

---

The types of the keys and values of this dictionary are unclear. I infer from call sites that it's `dict[string, File]`.

Contributor guide

Open the contributing guide

Research direction

Start at the ctx.runfiles documentation page linked in the issue and read the symlinks parameter entry alongside the call sites mentioned in the report. Clarify the documented types of the dictionary's keys and values; the work is done when the entry explicitly states those types.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.