Skip to content

Commit 868d93b

Browse files
committed
update bot usage docs to match implementation
fixes #783
1 parent e3fbe04 commit 868d93b

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

docs/bot-usage.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -107,15 +107,17 @@ available:
107107
* `top-{n}`: run the experiment on the `n` most downloaded crates on
108108
[crates.io](crates.io) (e.g. `top-100`).
109109
* `random-{n}`: run the experiment on `n` randomly selected crates (e.g. `random-20`).
110-
* `list:{...}`: run the experiment on the specified crates.
110+
* `list:{...}`: run the experiment on the comma-seperated list of crates.
111+
* `{url}`: run the experiment on the crates specified in the file specified by `{url}`,
112+
The url must start with `http[s]://` and must point to a list in the format of a crater runs [`retry-regressed-list.txt`][retry-list].
111113

112-
For `list:`, the value after the colon can either be a comma-separated list of
113-
crates to run or a link to a newline-separated list of crates ([example][list]).
114-
For example, `list:lazy_static,brson/hello-rs` and `list:https://git.io/Jes7o`
115-
will both run an experiment on the `lazy_static` crate and the git repo at
116-
`github.com/brson/hello-rs`. A link must begin with `http[s]://`.
114+
### Examples
117115

118-
[list]: https://gist.githubusercontent.com/ecstatic-morse/837c558b63fc73ab469bfbf4ad419a1f/raw/example-crate-list
116+
Both of the following will run an experiment on the `lazy_static` crate and the git repo at `github.com/brson/hello-rs`
117+
- `crates=list:lazy_static,brson/hello-rs`
118+
- `crates=https://git.io/Jes7o`
119+
120+
[retry-list]: https://crater-reports.s3.amazonaws.com/pr-133502-3/retry-regressed-list.txt
119121

120122
[Go back to the TOC][h-toc]
121123

0 commit comments

Comments
 (0)