Skip to content

Commit fd912e6

Browse files
authored
Updated crate_universe docs. (#1212)
* Updated crate_universe docs. * Regenerate documentation
1 parent cde4c08 commit fd912e6

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

crate_universe/defs.bzl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ the [./examples/crate_universe](https://github.com/bazelbuild/rules_rust/tree/ma
4040
### Cargo Workspaces
4141
4242
One of the simpler ways to wire up dependencies would be to first structure your project into a [Cargo workspace][cw].
43-
The `crates_repository` rule can ingest a the root `Cargo.toml` file and generate dependencies from there.
43+
The `crates_repository` rule can ingest a root `Cargo.toml` file and generate dependencies from there.
4444
4545
```python
46-
load("@rules_rust//crate_universe:defs.bzl", "crate", "crates_repository")
46+
load("@rules_rust//crate_universe:defs.bzl", "crates_repository")
4747
4848
crates_repository(
4949
name = "crate_index",

docs/crate_universe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ the [./examples/crate_universe](https://github.com/bazelbuild/rules_rust/tree/ma
4242
### Cargo Workspaces
4343

4444
One of the simpler ways to wire up dependencies would be to first structure your project into a [Cargo workspace][cw].
45-
The `crates_repository` rule can ingest a the root `Cargo.toml` file and generate dependencies from there.
45+
The `crates_repository` rule can ingest a root `Cargo.toml` file and generate dependencies from there.
4646

4747
```python
48-
load("@rules_rust//crate_universe:defs.bzl", "crate", "crates_repository")
48+
load("@rules_rust//crate_universe:defs.bzl", "crates_repository")
4949

5050
crates_repository(
5151
name = "crate_index",

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ You can also browse the [full API in one page](flatten.md).
5656

5757
### Experimental rules
5858

59-
- [crate_universe](crate_universe.md): A repository rule for fetching dependencies from a crate registry.
59+
- [crate_universe](crate_universe.md): Rules for generating Bazel targets for external crate depednencies.
6060
- [rust_analyzer](rust_analyzer.md): rules for generating `rust-project.json` files for [rust-analyzer](https://rust-analyzer.github.io/)
6161

6262
## Specifying Rust version
@@ -81,5 +81,5 @@ rust_repositories(rustfmt_version = "1.53.0")
8181

8282
## External Dependencies
8383

84-
Currently, the most common approach to managing external dependencies is using
84+
If [crate_universe]crate_universe.md) does not suit your needs, another common approach to managing external dependencies is using
8585
[cargo-raze](https://github.com/google/cargo-raze) to generate `BUILD` files for Cargo crates.

0 commit comments

Comments
 (0)