Documentation issue: actions.write with args content
Open
not stale
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/master/skylark/lib/actions.html#write
"May be a either a string or an actions.args() object." is all it says about passing an args object to `content` here. What does that actually *do* though? How are the args processed? What is the intended use case?
Contributor guide
Research direction
Start with the actions.write section at the linked actions.html#write documentation page, then investigate how an actions.args() object is processed when passed as content. Update the documentation to explain that processing and the intended use case, including enough detail for users to understand when to pass an args object.
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
- 42/100