Skip to content

Commit 0d1ad45

Browse files
authored
fix crate documentation (#4415)
## Motivation Make crate documentation uniform ## Proposal Add missing data ## Test Plan CI ## Release Plan - These changes should be backported to the latest `testnet` branch, then
1 parent 64bbd34 commit 0d1ad45

File tree

4 files changed

+29
-6
lines changed

4 files changed

+29
-6
lines changed

linera-metrics/Cargo.toml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
[package]
22
name = "linera-metrics"
3-
version.workspace = true
3+
description = "A library for Linera server metrics."
4+
readme = "README.md"
5+
documentation = "https://docs.rs/linera-metrics/latest/linera_metrics/"
6+
47
authors.workspace = true
5-
repository.workspace = true
8+
edition.workspace = true
69
homepage.workspace = true
710
license.workspace = true
8-
edition.workspace = true
11+
repository.workspace = true
12+
version.workspace = true
913

1014
[dependencies]
1115
anyhow.workspace = true

linera-metrics/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- cargo-rdme start -->
2+
3+
A library for Linera server metrics.
4+
5+
<!-- cargo-rdme end -->
6+
7+
## Contributing
8+
9+
See the [CONTRIBUTING](../CONTRIBUTING.md) file for how to help out.
10+
11+
## License
12+
13+
This project is available under the terms of the [Apache 2.0 license](../LICENSE).

linera-metrics/src/lib.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
// Copyright (c) Zefchain Labs, Inc.
22
// SPDX-License-Identifier: Apache-2.0
33

4+
//! A library for Linera server metrics.
5+
46
pub mod prometheus_server;

linera-persistent/Cargo.toml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
[package]
22
name = "linera-persistent"
3-
version.workspace = true
3+
description = "A library for persisting data types to disk with a variety of backends."
4+
readme = "README.md"
5+
documentation = "https://docs.rs/linera-persistent/latest/linera_persistent/"
6+
47
authors.workspace = true
5-
repository.workspace = true
8+
edition.workspace = true
69
homepage.workspace = true
710
license.workspace = true
8-
edition.workspace = true
11+
repository.workspace = true
12+
version.workspace = true
913

1014
[features]
1115
fs = ["fs-err", "fs4"]

0 commit comments

Comments
 (0)