Skip to content

Commit 6be1265

Browse files
committed
Auto merge of #6863 - daxpedda:patch-1, r=alexcrichton
Improved docs for `maintenance` options I thought the lack of clear meanings for the available options could use some improvement. Basically an upgrade of #4431. Got the relevant text from rust-lang/crates.io#704 and the corresponding [rfc](https://github.com/rust-lang/rfcs/blob/master/text/1824-crates.io-default-ranking.md) *Questions* 1. Should I put the descriptions outside of the code block? 2. I copied the wording including "maintainer" and "author", should I replace it with "you" or something more appropriate?
2 parents 96e9496 + dee137b commit 6be1265

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

src/doc/src/reference/manifest.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -298,9 +298,21 @@ is-it-maintained-issue-resolution = { repository = "..." }
298298
# Is it maintained percentage of open issues: `repository` is required.
299299
is-it-maintained-open-issues = { repository = "..." }
300300

301-
# Maintenance: `status` is required. Available options are `actively-developed`,
302-
# `passively-maintained`, `as-is`, `experimental`, `looking-for-maintainer`,
303-
# `deprecated`, and the default `none`, which displays no badge on crates.io.
301+
# Maintenance: `status` is required. Available options are:
302+
# - `actively-developed`: New features are being added and bugs are being fixed.
303+
# - `passively-maintained`: There are no plans for new features, but the maintainer intends to
304+
# respond to issues that get filed.
305+
# - `as-is`: The crate is feature complete, the maintainer does not intend to continue working on
306+
# it or providing support, but it works for the purposes it was designed for.
307+
# - `experimental`: The author wants to share it with the community but is not intending to meet
308+
# anyone's particular use case.
309+
# - `looking-for-maintainer`: The current maintainer would like to transfer the crate to someone
310+
# else.
311+
# - `deprecated`: The maintainer does not recommend using this crate (the description of the crate
312+
# can describe why, there could be a better solution available or there could be problems with
313+
# the crate that the author does not want to fix).
314+
# - `none`: Displays no badge on crates.io, since the maintainer has not chosen to specify
315+
# their intentions, potential crate users will need to investigate on their own.
304316
maintenance = { status = "..." }
305317
```
306318

0 commit comments

Comments
 (0)