Skip to content

Commit

Permalink
docs: fix refs to precompile source retention flag/attr in precompili…
Browse files Browse the repository at this point in the history
…ng docs (#2419)

Regular md docs need the `bzl:` prefix. Without it, the string doesn't
render at all.
  • Loading branch information
rickeylev authored Nov 18, 2024
1 parent 1944874 commit 15e9b4a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/precompiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ A pyc-only build (aka "source less" builds) is when only `.pyc` files are
included; the source `.py` files are not included.

To enable this, set
{obj}`--@rules_python//python/config_settings:precompile_source_retention=omit_source`
flag on the command line or the {attr}`precompile_source_retention=omit_source`
{bzl:obj}`--@rules_python//python/config_settings:precompile_source_retention=omit_source`
flag on the command line or the {bzl:attr}`precompile_source_retention=omit_source`
attribute on specific targets.

The advantage of pyc-only builds are:
Expand Down

0 comments on commit 15e9b4a

Please sign in to comment.