Skip to content

Commit ccf3387

Browse files
committed
updates from review
1 parent fbe0cd5 commit ccf3387

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

gazelle/docs/index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Gazelle Plugin
22

33
[Gazelle][gazelle] is a build file generator for Bazel projects. It can
4-
create new {code}`BUILD` or {code}`BUILD.bazel` files for a project that
4+
create new `BUILD` or `BUILD.bazel` files for a project that
55
follows language conventions and update existing build files to include new
66
sources, dependencies, and options.
77

@@ -11,11 +11,11 @@ Bazel may run Gazelle using the Gazelle rule, or Gazelle may be installed and ru
1111
as a command line tool.
1212

1313
The {gh-path}`gazelle` directory contains a plugin for Gazelle
14-
that generates {code}`BUILD` files content for Python code. When Gazelle is
14+
that generates `BUILD` files content for Python code. When Gazelle is
1515
run as a command line tool with this plugin, it embeds a Python interpreter
1616
resolved during the plugin build. The behavior of the plugin is slightly
1717
different with different version of the interpreter as the Python
18-
{code}`stdlib` changes with every minor version release. Distributors of Gazelle
18+
`stdlib` changes with every minor version release. Distributors of Gazelle
1919
binaries should, therefore, build a Gazelle binary for each OS+CPU
2020
architecture+Minor Python version combination they are targeting.
2121

@@ -25,19 +25,19 @@ older documentation that includes instructions on how to use Gazelle
2525
without using bzlmod as your dependency manager.
2626
:::
2727

28-
[bzlmod]: https://docs.bazel.build/versions/5.0.0/bzlmod.html
28+
[bzlmod]: https://bazel.build/external/module
2929

30-
Gazelle is non-destructive. It will try to leave your edits to {code}`BUILD`
31-
files alone, only making updates to {code}`py_*` targets. However it **will
30+
Gazelle is non-destructive. It will try to leave your edits to `BUILD`
31+
files alone, only making updates to `py_*` targets. However it **will
3232
remove** dependencies that appear to be unused, so it's a good idea to check
3333
in your work before running Gazelle so you can easily revert any changes it made.
3434

35-
The {code}`rules_python` extension assumes some conventions about your Python code.
35+
The `rules_python` extension assumes some conventions about your Python code.
3636
These are noted in the subsequent documents, and might require changes to your
3737
existing code.
3838

39-
Note that the {code}`gazelle` program has multiple commands. At present, only
40-
the {code}`update` command (the default) does anything for Python code.
39+
Note that the `gazelle` program has multiple commands. At present, only
40+
the `update` command (the default) does anything for Python code.
4141

4242

4343
```{toctree}

0 commit comments

Comments
 (0)