diff --git a/docs/flatten.md b/docs/flatten.md index d6ae3a08aa..a6c822cf93 100644 --- a/docs/flatten.md +++ b/docs/flatten.md @@ -430,7 +430,7 @@ rust_clippy( ## rust_doc
-rust_doc(name, dep, html_after_content, html_before_content, html_in_header, markdown_css) +rust_doc(name, crate, dep, html_after_content, html_before_content, html_in_header, markdown_css)Generates code documentation. @@ -463,7 +463,7 @@ Example: rust_doc( name = "hello_lib_doc", - dep = ":hello_lib", + crate = ":hello_lib", ) ``` @@ -476,7 +476,8 @@ Example: | Name | Description | Type | Mandatory | Default | | :------------- | :------------- | :------------- | :------------- | :------------- | | name | A unique name for this target. | Name | required | | -| dep | The label of the target to generate code documentation for.
rust_doc
can generate HTML code documentation for the source files of rust_library
or rust_binary
targets. | Label | required | |
+| crate | The label of the target to generate code documentation for.rust_doc
can generate HTML code documentation for the source files of rust_library
or rust_binary
targets. | Label | optional | None |
+| dep | __deprecated__: use crate
| Label | optional | None |
| html_after_content | File to add in <body>
, after content. | Label | optional | None |
| html_before_content | File to add in <body>
, before content. | Label | optional | None |
| html_in_header | File to add to <head>
. | Label | optional | None |
@@ -488,7 +489,7 @@ Example:
## rust_doc_test
-rust_doc_test(name, dep) +rust_doc_test(name, crate, dep)Runs Rust documentation tests. @@ -522,7 +523,7 @@ rust_library( rust_doc_test( name = "hello_lib_doc_test", - dep = ":hello_lib", + crate = ":hello_lib", ) ``` @@ -535,7 +536,8 @@ Running `bazel test //hello_lib:hello_lib_doc_test` will run all documentation t | Name | Description | Type | Mandatory | Default | | :------------- | :------------- | :------------- | :------------- | :------------- | | name | A unique name for this target. | Name | required | | -| dep | The label of the target to run documentation tests for.
rust_doc_test
can run documentation tests for the source files of rust_library
or rust_binary
targets. | Label | required | |
+| crate | The label of the target to generate code documentation for.rust_doc_test
can generate HTML code documentation for the source files of rust_library
or rust_binary
targets. | Label | optional | None |
+| dep | __deprecated__: use crate
| Label | optional | None |
diff --git a/docs/rust_doc.md b/docs/rust_doc.md
index 6be6d11516..12f54846ed 100644
--- a/docs/rust_doc.md
+++ b/docs/rust_doc.md
@@ -9,7 +9,7 @@
## rust_doc
-rust_doc(name, dep, html_after_content, html_before_content, html_in_header, markdown_css) +rust_doc(name, crate, dep, html_after_content, html_before_content, html_in_header, markdown_css)Generates code documentation. @@ -42,7 +42,7 @@ Example: rust_doc( name = "hello_lib_doc", - dep = ":hello_lib", + crate = ":hello_lib", ) ``` @@ -55,7 +55,8 @@ Example: | Name | Description | Type | Mandatory | Default | | :------------- | :------------- | :------------- | :------------- | :------------- | | name | A unique name for this target. | Name | required | | -| dep | The label of the target to generate code documentation for.
rust_doc
can generate HTML code documentation for the source files of rust_library
or rust_binary
targets. | Label | required | |
+| crate | The label of the target to generate code documentation for.rust_doc
can generate HTML code documentation for the source files of rust_library
or rust_binary
targets. | Label | optional | None |
+| dep | __deprecated__: use crate
| Label | optional | None |
| html_after_content | File to add in <body>
, after content. | Label | optional | None |
| html_before_content | File to add in <body>
, before content. | Label | optional | None |
| html_in_header | File to add to <head>
. | Label | optional | None |
@@ -67,7 +68,7 @@ Example:
## rust_doc_test
-rust_doc_test(name, dep) +rust_doc_test(name, crate, dep)Runs Rust documentation tests. @@ -101,7 +102,7 @@ rust_library( rust_doc_test( name = "hello_lib_doc_test", - dep = ":hello_lib", + crate = ":hello_lib", ) ``` @@ -114,6 +115,7 @@ Running `bazel test //hello_lib:hello_lib_doc_test` will run all documentation t | Name | Description | Type | Mandatory | Default | | :------------- | :------------- | :------------- | :------------- | :------------- | | name | A unique name for this target. | Name | required | | -| dep | The label of the target to run documentation tests for.
rust_doc_test
can run documentation tests for the source files of rust_library
or rust_binary
targets. | Label | required | |
+| crate | The label of the target to generate code documentation for.rust_doc_test
can generate HTML code documentation for the source files of rust_library
or rust_binary
targets. | Label | optional | None |
+| dep | __deprecated__: use crate
| Label | optional | None |