Skip to content

Commit db17f29

Browse files
uhthomasUebelAndre
andauthored
Fix crate annotation anchor (#1282)
Co-authored-by: UebelAndre <[email protected]>
1 parent fdb6851 commit db17f29

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

crate_universe/private/crates_repository.bzl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Environment Variables:
116116
implementation = _crates_repository_impl,
117117
attrs = {
118118
"annotations": attr.string_list_dict(
119-
doc = "Extra settings to apply to crates. See [crate.annotations](#crateannotations).",
119+
doc = "Extra settings to apply to crates. See [crate.annotation](#crateannotation).",
120120
),
121121
"cargo_config": attr.label(
122122
doc = "A [Cargo configuration](https://doc.rust-lang.org/cargo/reference/config.html) file",

crate_universe/private/crates_vendor.bzl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ crates_vendor = rule(
242242
doc = "A rule for defining Rust dependencies (crates) and writing targets for them to the current workspace",
243243
attrs = {
244244
"annotations": attr.string_list_dict(
245-
doc = "Extra settings to apply to crates. See [crate.annotations](#crateannotations).",
245+
doc = "Extra settings to apply to crates. See [crate.annotation](#crateannotation).",
246246
),
247247
"buildifier": attr.label(
248248
doc = "The path to a [buildifier](https://github.com/bazelbuild/buildtools/blob/5.0.1/buildifier/README.md) binary used to format generated BUILD files.",

docs/crate_universe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ Environment Variables:
194194
| Name | Description | Type | Mandatory | Default |
195195
| :------------- | :------------- | :------------- | :------------- | :------------- |
196196
| <a id="crates_repository-name"></a>name | A unique name for this repository. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | |
197-
| <a id="crates_repository-annotations"></a>annotations | Extra settings to apply to crates. See [crate.annotations](#crateannotations). | <a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> List of strings</a> | optional | {} |
197+
| <a id="crates_repository-annotations"></a>annotations | Extra settings to apply to crates. See [crate.annotation](#crateannotation). | <a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> List of strings</a> | optional | {} |
198198
| <a id="crates_repository-cargo_config"></a>cargo_config | A [Cargo configuration](https://doc.rust-lang.org/cargo/reference/config.html) file | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | None |
199199
| <a id="crates_repository-extra_workspace_member_url_template"></a>extra_workspace_member_url_template | The registry url to use when fetching extra workspace members | String | optional | "https://crates.io/api/v1/crates/{name}/{version}/download" |
200200
| <a id="crates_repository-extra_workspace_members"></a>extra_workspace_members | Additional crates to download and include as a workspace member. This is unfortunately required in order to add information about "binary-only" crates so that a <code>rust_binary</code> may be generated for it. [rust-lang/cargo#9096](https://github.com/rust-lang/cargo/issues/9096) tracks an RFC which may solve for this. | <a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a> | optional | {} |
@@ -234,7 +234,7 @@ A rule for defining Rust dependencies (crates) and writing targets for them to t
234234
| Name | Description | Type | Mandatory | Default |
235235
| :------------- | :------------- | :------------- | :------------- | :------------- |
236236
| <a id="crates_vendor-name"></a>name | A unique name for this target. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | |
237-
| <a id="crates_vendor-annotations"></a>annotations | Extra settings to apply to crates. See [crate.annotations](#crateannotations). | <a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> List of strings</a> | optional | {} |
237+
| <a id="crates_vendor-annotations"></a>annotations | Extra settings to apply to crates. See [crate.annotation](#crateannotation). | <a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> List of strings</a> | optional | {} |
238238
| <a id="crates_vendor-buildifier"></a>buildifier | The path to a [buildifier](https://github.com/bazelbuild/buildtools/blob/5.0.1/buildifier/README.md) binary used to format generated BUILD files. | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | //crate_universe/private/vendor:buildifier |
239239
| <a id="crates_vendor-cargo_bazel"></a>cargo_bazel | The cargo-bazel binary to use for vendoring. If this attribute is not set, then a <code>CARGO_BAZEL_GENERATOR_PATH</code> action env will be used. | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | @cargo_bazel_bootstrap//:binary |
240240
| <a id="crates_vendor-generate_build_scripts"></a>generate_build_scripts | Whether or not to generate [cargo build scripts](https://doc.rust-lang.org/cargo/reference/build-scripts.html) by default. | Boolean | optional | True |

0 commit comments

Comments
 (0)