Skip to content

Commit

Permalink
Work around bazelbuild/stardoc#78.
Browse files Browse the repository at this point in the history
Markdown bullet lists work fine in the general descriptions block of macros/rules/providers, but for rule attributes and provider fields the the markdown is a table, and `*` has no means (and stardoc transforms the content to remove newlines). The above issue is to support catch these and marking html bullet lists out of them, but until that is done, adding a blank line between each bullet gets slightly more readable generated/render documents.

PiperOrigin-RevId: 348682502
  • Loading branch information
thomasvl authored and swiple-rules-gardener committed Dec 22, 2020
1 parent df1198b commit 5383052
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 0 deletions.
1 change: 1 addition & 0 deletions swift/internal/attrs.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@ Allowed kinds of dependencies are:
* `swift_c_module`, `swift_import` and `swift_library` (or anything
propagating `SwiftInfo`)
* `cc_library` (or anything propagating `CcInfo`)
Additionally, on platforms that support Objective-C interop, `objc_library`
Expand Down
2 changes: 2 additions & 0 deletions swift/internal/providers.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ The partial should be called with two arguments:
* `is_static`: A `Boolean` value indicating whether to link against the static
or dynamic runtime libraries.
* `is_test`: A `Boolean` value indicating whether the target being linked is a
test target.
""",
Expand Down Expand Up @@ -153,6 +154,7 @@ compiles).
* `env`: A `dict` of environment variables to be set when running tests
that were built with this toolchain.
* `execution_requirements`: A `dict` of execution requirements for tests
that were built with this toolchain.
Expand Down
2 changes: 2 additions & 0 deletions swift/internal/swift_binary_test.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,10 @@ into the binary. Possible values are:
* `stamp = 1`: Stamp the build information into the binary. Stamped binaries are
only rebuilt when their dependencies change. Use this if there are tests that
depend on the build information.
* `stamp = 0`: Always replace build information by constant values. This gives
good build result caching.
* `stamp = -1`: Embedding of build information is controlled by the
`--[no]stamp` flag.
""",
Expand Down
2 changes: 2 additions & 0 deletions swift/internal/swift_grpc_library.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,9 @@ on the `swift_grpc_library` implementing the service.
The kind of definitions that should be generated:
* `"client"` to generate client definitions.
* `"client_stubs"` to generate client test stubs.
* `"server"` to generate server definitions.
""",
),
Expand Down

1 comment on commit 5383052

@keith
Copy link
Member

@keith keith commented on 5383052 Dec 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.