Minor cleanup (#1017)

Author: UebelAndre

.bazelci/presubmit.yml

@@ -67,7 +67,7 @@ tasks:
       # rust_doc_test is likely not fully sandboxed
       - "-//test/chained_direct_deps:mod3_doc_test"
     build_flags: *aspects_flags
-  rbe_ubuntu1604_with_aspects:
+  rbe_ubuntu1604_rolling_with_aspects:
     name: RBE Rolling Bazel Version With Aspects
     platform: rbe_ubuntu1604
     shell_commands:

docs/flatten.md

@@ -446,38 +446,38 @@ rust_doc(<a href="#rust_doc-name">name</a>, <a href="#rust_doc-crate">crate</a>,
 Generates code documentation.
 
 Example:
-  Suppose you have the following directory structure for a Rust library crate:
+Suppose you have the following directory structure for a Rust library crate:
 
-  ```
-  [workspace]/
-      WORKSPACE
-      hello_lib/
-          BUILD
-          src/
-              lib.rs
-  ```
+```
+[workspace]/
+    WORKSPACE
+    hello_lib/
+        BUILD
+        src/
+            lib.rs
+```
 
-  To build [`rustdoc`][rustdoc] documentation for the `hello_lib` crate, define   a `rust_doc` rule that depends on the the `hello_lib` `rust_library` target:
+To build [`rustdoc`][rustdoc] documentation for the `hello_lib` crate, define     a `rust_doc` rule that depends on the the `hello_lib` `rust_library` target:
 
-  [rustdoc]: https://doc.rust-lang.org/book/documentation.html
+[rustdoc]: https://doc.rust-lang.org/book/documentation.html
 
-  ```python
-  package(default_visibility = ["//visibility:public"])
+```python
+package(default_visibility = ["//visibility:public"])
 
-  load("@rules_rust//rust:defs.bzl", "rust_library", "rust_doc")
+load("@rules_rust//rust:defs.bzl", "rust_library", "rust_doc")
 
-  rust_library(
-      name = "hello_lib",
-      srcs = ["src/lib.rs"],
-  )
+rust_library(
+    name = "hello_lib",
+    srcs = ["src/lib.rs"],
+)
 
-  rust_doc(
-      name = "hello_lib_doc",
-      crate = ":hello_lib",
-  )
-  ```
+rust_doc(
+    name = "hello_lib_doc",
+    crate = ":hello_lib",
+)
+```
 
-  Running `bazel build //hello_lib:hello_lib_doc` will build a zip file containing   the documentation for the `hello_lib` library crate generated by `rustdoc`.
+Running `bazel build //hello_lib:hello_lib_doc` will build a zip file containing     the documentation for the `hello_lib` library crate generated by `rustdoc`.
 
 
 **ATTRIBUTES**
@@ -510,14 +510,14 @@ Suppose you have the following directory structure for a Rust library crate:
 
 ```output
 [workspace]/
-  WORKSPACE
-  hello_lib/
-      BUILD
-      src/
-          lib.rs
+WORKSPACE
+hello_lib/
+    BUILD
+    src/
+        lib.rs
 ```
 
-To run [documentation tests][doc-test] for the `hello_lib` crate, define a `rust_doc_test` target that depends on the `hello_lib` `rust_library` target:
+To run [documentation tests][doc-test] for the `hello_lib` crate, define a `rust_doc_test`         target that depends on the `hello_lib` `rust_library` target:
 
 [doc-test]: https://doc.rust-lang.org/book/documentation.html#documentation-as-tests
 

docs/rust_doc.md

@@ -15,38 +15,38 @@ rust_doc(<a href="#rust_doc-name">name</a>, <a href="#rust_doc-crate">crate</a>,
 Generates code documentation.
 
 Example:
-  Suppose you have the following directory structure for a Rust library crate:
+Suppose you have the following directory structure for a Rust library crate:
 
-  ```
-  [workspace]/
-      WORKSPACE
-      hello_lib/
-          BUILD
-          src/
-              lib.rs
-  ```
+```
+[workspace]/
+    WORKSPACE
+    hello_lib/
+        BUILD
+        src/
+            lib.rs
+```
 
-  To build [`rustdoc`][rustdoc] documentation for the `hello_lib` crate, define   a `rust_doc` rule that depends on the the `hello_lib` `rust_library` target:
+To build [`rustdoc`][rustdoc] documentation for the `hello_lib` crate, define     a `rust_doc` rule that depends on the the `hello_lib` `rust_library` target:
 
-  [rustdoc]: https://doc.rust-lang.org/book/documentation.html
+[rustdoc]: https://doc.rust-lang.org/book/documentation.html
 
-  ```python
-  package(default_visibility = ["//visibility:public"])
+```python
+package(default_visibility = ["//visibility:public"])
 
-  load("@rules_rust//rust:defs.bzl", "rust_library", "rust_doc")
+load("@rules_rust//rust:defs.bzl", "rust_library", "rust_doc")
 
-  rust_library(
-      name = "hello_lib",
-      srcs = ["src/lib.rs"],
-  )
+rust_library(
+    name = "hello_lib",
+    srcs = ["src/lib.rs"],
+)
 
-  rust_doc(
-      name = "hello_lib_doc",
-      crate = ":hello_lib",
-  )
-  ```
+rust_doc(
+    name = "hello_lib_doc",
+    crate = ":hello_lib",
+)
+```
 
-  Running `bazel build //hello_lib:hello_lib_doc` will build a zip file containing   the documentation for the `hello_lib` library crate generated by `rustdoc`.
+Running `bazel build //hello_lib:hello_lib_doc` will build a zip file containing     the documentation for the `hello_lib` library crate generated by `rustdoc`.
 
 
 **ATTRIBUTES**
@@ -79,14 +79,14 @@ Suppose you have the following directory structure for a Rust library crate:
 
 ```output
 [workspace]/
-  WORKSPACE
-  hello_lib/
-      BUILD
-      src/
-          lib.rs
+WORKSPACE
+hello_lib/
+    BUILD
+    src/
+        lib.rs
 ```
 
-To run [documentation tests][doc-test] for the `hello_lib` crate, define a `rust_doc_test` target that depends on the `hello_lib` `rust_library` target:
+To run [documentation tests][doc-test] for the `hello_lib` crate, define a `rust_doc_test`         target that depends on the `hello_lib` `rust_library` target:
 
 [doc-test]: https://doc.rust-lang.org/book/documentation.html#documentation-as-tests
 

rust/private/rustc.bzl

@@ -495,9 +495,8 @@ def construct_arguments(
                     This is to be passed to the `arguments` parameter of actions
             - (dict): Common rustc environment variables
     """
-    output_dir = getattr(crate_info.output, "dirname") if hasattr(crate_info.output, "dirname") else None
-
-    linker_script = getattr(file, "linker_script") if hasattr(file, "linker_script") else None
+    output_dir = getattr(crate_info.output, "dirname", None)
+    linker_script = getattr(file, "linker_script", None)
 
     env = _get_rustc_env(attr, toolchain, crate_info.name)
 

rust/private/rustdoc.bzl

@@ -12,49 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# buildifier: disable=module-docstring
+"""Rules for generating documentation with `rustdoc` for Bazel built crates"""
+
 load("//rust/private:common.bzl", "rust_common")
 load("//rust/private:rustc.bzl", "add_crate_link_flags", "add_edition_flags")
-load("//rust/private:utils.bzl", "find_toolchain")
-
-_rust_doc_doc = """Generates code documentation.
-
-Example:
-  Suppose you have the following directory structure for a Rust library crate:
-
-  ```
-  [workspace]/
-      WORKSPACE
-      hello_lib/
-          BUILD
-          src/
-              lib.rs
-  ```
-
-  To build [`rustdoc`][rustdoc] documentation for the `hello_lib` crate, define \
-  a `rust_doc` rule that depends on the the `hello_lib` `rust_library` target:
-
-  [rustdoc]: https://doc.rust-lang.org/book/documentation.html
-
-  ```python
-  package(default_visibility = ["//visibility:public"])
-
-  load("@rules_rust//rust:defs.bzl", "rust_library", "rust_doc")
-
-  rust_library(
-      name = "hello_lib",
-      srcs = ["src/lib.rs"],
-  )
-
-  rust_doc(
-      name = "hello_lib_doc",
-      crate = ":hello_lib",
-  )
-  ```
-
-  Running `bazel build //hello_lib:hello_lib_doc` will build a zip file containing \
-  the documentation for the `hello_lib` library crate generated by `rustdoc`.
-"""
+load("//rust/private:utils.bzl", "dedent", "find_toolchain")
 
 def _rust_doc_impl(ctx):
     """The implementation of the `rust_doc` rule
@@ -146,7 +108,45 @@ def _zip_action(ctx, input_dir, output_zip):
     )
 
 rust_doc = rule(
-    doc = _rust_doc_doc,
+    doc = dedent("""\
+    Generates code documentation.
+
+    Example:
+    Suppose you have the following directory structure for a Rust library crate:
+
+    ```
+    [workspace]/
+        WORKSPACE
+        hello_lib/
+            BUILD
+            src/
+                lib.rs
+    ```
+
+    To build [`rustdoc`][rustdoc] documentation for the `hello_lib` crate, define \
+    a `rust_doc` rule that depends on the the `hello_lib` `rust_library` target:
+
+    [rustdoc]: https://doc.rust-lang.org/book/documentation.html
+
+    ```python
+    package(default_visibility = ["//visibility:public"])
+
+    load("@rules_rust//rust:defs.bzl", "rust_library", "rust_doc")
+
+    rust_library(
+        name = "hello_lib",
+        srcs = ["src/lib.rs"],
+    )
+
+    rust_doc(
+        name = "hello_lib_doc",
+        crate = ":hello_lib",
+    )
+    ```
+
+    Running `bazel build //hello_lib:hello_lib_doc` will build a zip file containing \
+    the documentation for the `hello_lib` library crate generated by `rustdoc`.
+    """),
     implementation = _rust_doc_impl,
     attrs = {
         "crate": attr.label(

rust/private/rustdoc_test.bzl

@@ -12,9 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# buildifier: disable=module-docstring
+"""Rules for performing `rustdoc --test` on Bazel built crates"""
+
 load("//rust/private:common.bzl", "rust_common")
-load("//rust/private:utils.bzl", "find_toolchain", "get_lib_name", "get_preferred_artifact")
+load("//rust/private:utils.bzl", "dedent", "find_toolchain", "get_lib_name", "get_preferred_artifact")
 
 def _rust_doc_test_impl(ctx):
     """The implementation for the `rust_doc_test` rule
@@ -217,42 +218,43 @@ rust_doc_test = rule(
     test = True,
     toolchains = [str(Label("//rust:toolchain"))],
     incompatible_use_toolchain_transition = True,
-    doc = """Runs Rust documentation tests.
+    doc = dedent("""\
+        Runs Rust documentation tests.
 
-Example:
+        Example:
 
-Suppose you have the following directory structure for a Rust library crate:
+        Suppose you have the following directory structure for a Rust library crate:
 
-```output
-[workspace]/
-  WORKSPACE
-  hello_lib/
-      BUILD
-      src/
-          lib.rs
-```
+        ```output
+        [workspace]/
+        WORKSPACE
+        hello_lib/
+            BUILD
+            src/
+                lib.rs
+        ```
 
-To run [documentation tests][doc-test] for the `hello_lib` crate, define a `rust_doc_test` \
-target that depends on the `hello_lib` `rust_library` target:
+        To run [documentation tests][doc-test] for the `hello_lib` crate, define a `rust_doc_test` \
+        target that depends on the `hello_lib` `rust_library` target:
 
-[doc-test]: https://doc.rust-lang.org/book/documentation.html#documentation-as-tests
+        [doc-test]: https://doc.rust-lang.org/book/documentation.html#documentation-as-tests
 
-```python
-package(default_visibility = ["//visibility:public"])
+        ```python
+        package(default_visibility = ["//visibility:public"])
 
-load("@rules_rust//rust:defs.bzl", "rust_library", "rust_doc_test")
+        load("@rules_rust//rust:defs.bzl", "rust_library", "rust_doc_test")
 
-rust_library(
-    name = "hello_lib",
-    srcs = ["src/lib.rs"],
-)
+        rust_library(
+            name = "hello_lib",
+            srcs = ["src/lib.rs"],
+        )
 
-rust_doc_test(
-    name = "hello_lib_doc_test",
-    crate = ":hello_lib",
-)
-```
+        rust_doc_test(
+            name = "hello_lib_doc_test",
+            crate = ":hello_lib",
+        )
+        ```
 
-Running `bazel test //hello_lib:hello_lib_doc_test` will run all documentation tests for the `hello_lib` library crate.
-""",
+        Running `bazel test //hello_lib:hello_lib_doc_test` will run all documentation tests for the `hello_lib` library crate.
+    """),
 )