bazel-contrib / bazel-contrib/bazel-lib

[FR]: Extend docs to explain difference to other/similar/mirrored functions

Open
#885 4 comments 0 reactions 0 assignees View on GitHub
enhancement need: discussion
Dominant language
Starlark
Stars
182
Forks
134
Avg merge
1d 46m
Merged PRs (30d)
1

Description

### What is the current behavior?

_No response_

### Describe the feature

Some of your rules such as [expand_template](https://docs.aspect.build/rulesets/aspect_bazel_lib/docs/expand_template/) are also available with the same name and interface in other projects such as [skylib's expand template](https://github.com/bazelbuild/bazel-skylib/blob/main/rules/expand_template.bzl). Maybe you could provide a brief explanation about the main differences between your rules and the others similar as you do it in https://docs.aspect.build/rulesets/aspect_bazel_lib/docs/tar

Contributor guide

Open the contributing guide

Research direction

Start with the expand_template documentation linked in the issue and compare its interface with skylib's expand_template. Review the existing tar documentation for the expected comparison style, then document the main differences between the similar rules. Done means the expand_template page briefly explains how it differs from the other implementation.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.