Skip to content

Commit 6b5ecf7

Browse files
docs: Fix docs for gazelle usage (#3182)
1 parent 3ade15c commit 6b5ecf7

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

gazelle/docs/installation_and_usage.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,16 @@ load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")
8686
modules_mapping(
8787
name = "modules_map",
8888
wheels = all_whl_requirements,
89+
90+
# include_stub_packages: bool (default: False)
91+
# If set to True, this flag automatically includes any corresponding type stub packages
92+
# for the third-party libraries that are present and used. For example, if you have
93+
# `boto3` as a dependency, and this flag is enabled, the corresponding `boto3-stubs`
94+
# package will be automatically included in the BUILD file.
95+
# Enabling this feature helps ensure that type hints and stubs are readily available
96+
# for tools like type checkers and IDEs, improving the development experience and
97+
# reducing manual overhead in managing separate stub packages.
98+
include_stub_packages = True,
8999
)
90100

91101
# Gazelle python extension needs a manifest file mapping from
@@ -110,16 +120,6 @@ gazelle_python_manifest(
110120
# the integrity field is not added to the manifest which can help avoid
111121
# merge conflicts in large repos.
112122
requirements = "//:requirements_lock.txt",
113-
114-
# include_stub_packages: bool (default: False)
115-
# If set to True, this flag automatically includes any corresponding type stub packages
116-
# for the third-party libraries that are present and used. For example, if you have
117-
# `boto3` as a dependency, and this flag is enabled, the corresponding `boto3-stubs`
118-
# package will be automatically included in the BUILD file.
119-
# Enabling this feature helps ensure that type hints and stubs are readily available
120-
# for tools like type checkers and IDEs, improving the development experience and
121-
# reducing manual overhead in managing separate stub packages.
122-
include_stub_packages = True
123123
)
124124
```
125125

@@ -134,9 +134,9 @@ gazelle_binary(
134134
name = "gazelle_multilang",
135135
languages = [
136136
# List of language plugins.
137-
# If you want to generate py_proto_library targets PR #3057), then
137+
# If you want to generate py_proto_library targets (PR #3057), then
138138
# the proto language plugin _must_ come before the rules_python plugin.
139-
#"@bazel_gazelle//lanugage/proto",
139+
#"@bazel_gazelle//language/proto",
140140
"@rules_python_gazelle_plugin//python",
141141
],
142142
)

0 commit comments

Comments
 (0)