bazel-contrib / bazel-contrib/rules_python

docs: update py_wheel to show prefix stripping

Open
#3,218 0 comments 0 reactions 0 assignees View on GitHub
packaging type: documentation
Dominant language
Starlark
Stars
688
Forks
721
Avg merge
15h 7m
Merged PRs (30d)
76

Description

While talking to a user, they didn't realize py_wheel had a prefix-stripping ability.

With src-based layouts being common, I think it makes sense to update the example to show how to transform it into the desired wheel output. (This same problem would occur for a repo with multiple sub-projects, too).

Prompt:

```
Act as an expert in Sphinx, MyST, rules_python, Starlark, Bazel.

Update the py_wheel how to guide to show how to transform files using a src-layout.

Use the py_wheel.strip_path_prefixes arg to do this.
```

Contributor guide

Open the contributing guide

Research direction

Locate the py_wheel how-to guide and inspect its current example for a src-based layout. Use the documented py_wheel.strip_path_prefixes argument to show the transformation to the desired wheel output; done when the guide clearly demonstrates the resulting layout.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.