Skip to content

Commit d530b46

Browse files
committed
Auto merge of #13293 - dtolnay-contrib:homepage, r=weihanglo
Add guidance on setting homepage in manifest Carried over from the Rust API Guidelines: https://rust-lang.github.io/api-guidelines/documentation.html#cargotoml-includes-all-common-metadata-c-metadata This guidance has been in place since 6.5 years ago (rust-lang/api-guidelines@350619f).
2 parents 92395d9 + 7ccb4d3 commit d530b46

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/doc/src/reference/manifest.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,9 +244,13 @@ package.
244244
```toml
245245
[package]
246246
# ...
247-
homepage = "https://serde.rs/"
247+
homepage = "https://serde.rs"
248248
```
249249

250+
A value should only be set for `homepage` if there is a dedicated website for
251+
the crate other than the source repository or API documentation. Do not make
252+
`homepage` redundant with either the `documentation` or `repository` values.
253+
250254
### The `repository` field
251255

252256
The `repository` field should be a URL to the source repository for your
@@ -255,7 +259,7 @@ package.
255259
```toml
256260
[package]
257261
# ...
258-
repository = "https://github.com/rust-lang/cargo/"
262+
repository = "https://github.com/rust-lang/cargo"
259263
```
260264

261265
### The `license` and `license-file` fields

0 commit comments

Comments
 (0)