document weight field

This commit is contained in:
xenofem 2023-07-10 19:22:10 -04:00
parent 46b49ffda9
commit 1528bf3d9a

View file

@ -38,6 +38,7 @@ the list of shows the bot should take screencaps from is read from a YAML file w
```yaml ```yaml
Char's Counterattack: Char's Counterattack:
path: /home/user/media/Gundam_CCA.mkv path: /home/user/media/Gundam_CCA.mkv
weight: 2.5
Gundam 0079: Gundam 0079:
path: /home/user/media/Mobile Suit Gundam 0079/ path: /home/user/media/Mobile Suit Gundam 0079/
tags: tags:
@ -62,4 +63,6 @@ warnings on posts and in image alt text. each show has two keys:
- `parts`: an optional map of season numbers to season names. - `parts`: an optional map of season numbers to season names.
by default, if the bot detects episodes from multiple seasons in a directory, by default, if the bot detects episodes from multiple seasons in a directory,
it will refer to them as "season [number]" in post CWs and image alt-text. it will refer to them as "season [number]" in post CWs and image alt-text.
this is a map rather than a list, since show season numbers may be 1-indexed or 0-indexed. this is a map rather than a list, since show season numbers may be 1-indexed or 0-indexed.
- `weight`: an optional weight for this show in the random sampling of
shows. each show without a weight specified has a weight of `1.0`.