Skip to content

docs: fix requirement line for runfiles example #1052

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rickeylev merged 1 commit into from
Feb 9, 2023
Merged

docs: fix requirement line for runfiles example #1052

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions python/runfiles/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,21 @@ bazel-runfiles library

This is a Bazel Runfiles lookup library for Bazel-built Python binaries and tests.

Learn about runfiles: read `Runfiles guide <https://bazel.build/extending/rules#runfiles>`_
or watch `Fabian's BazelCon talk <https://www.youtube.com/watch?v=5NbgUMH1OGo>`_.

Typical Usage
-------------

1. Add the 'runfiles' dependency along with other third-party dependencies, for example in your
1. Add the 'bazel-runfiles' dependency along with other third-party dependencies, for example in your
``requirements.txt`` file.

2. Depend on this runfiles library from your build rule, like you would other third-party libraries::

py_binary(
name = "my_binary",
...
deps = [requirement("runfiles")],
deps = [requirement("bazel-runfiles")],
)

3. Import the runfiles library::
Expand Down