fix(template): consistency and verbage

chbgdn · Sep 25, 2023 · bc6a55e · bc6a55e
1 parent c0d368e
commit bc6a55e
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 18 deletions.
diff --git a/src/config.template.cjs b/src/config.template.cjs
@@ -76,11 +76,6 @@ module.exports = {
 	outputDir: ".",
 
 	/**
-	 * 
-	 * To search for all episodes, use (includeEpisodes: true, includeNonVideos: true)
-	 * To search for only single episodes, but exclude season pack episodes (data-based)
-	 *    use (includeEpisodes: false, includeSingleEpisodes: true, includeNonVideos: true)
-	 *
 	 * Whether to search for all episode torrents, including those from season packs. This option overrides includeSingleEpisodes.
 	 */
 	includeEpisodes: false,
@@ -93,8 +88,12 @@ module.exports = {
 
 	/**
 	 * Include torrents which contain non-video files
-	 * This option does not override includeEpisodes or
-	 * includeSingleEpisodes.
+	 * This option does not override includeEpisodes or includeSingleEpisodes.
+	 * 
+	 * To search for everything except episodes, use (includeEpisodes: false, includeSingleEpisodes: false, includeNonVideos: true)
+	 * To search for everything including episodes, use (includeEpisodes: true, includeNonVideos: true)
+	 * To search for everything except season pack episodes (data-based)
+	 *    use (includeEpisodes: false, includeSingleEpisodes: true, includeNonVideos: true)
 	 */
 	includeNonVideos: false,
 
@@ -166,6 +165,8 @@ module.exports = {
 	 * cross-seed will send POST requests to this url
 	 * with a JSON payload of { title, body }.
 	 * Conforms to the caronc/apprise REST API.
+	 * If necessary, supply your username and password inside the url like so:
+	 * "http://username:password@localhost:8000/notify/cross-seed"
 	 */
 	notificationWebhookUrl: undefined,
 
@@ -227,7 +228,7 @@ module.exports = {
 	searchTimeout: undefined,
 
 	/**
-	 * The number of searches to be done before it stop.
+	 * The number of searches to be done before it stops.
 	 * Combine this with "excludeRecentSearch" and "searchCadence" to smooth long-term API usage patterns.
 	 * Default is no limit.
 	 */

diff --git a/src/config.template.docker.cjs b/src/config.template.docker.cjs
@@ -80,25 +80,24 @@ module.exports = {
 	outputDir: "/cross-seeds",
 
 	/**
-	 * 
-	 * To search for all episodes, use (includeEpisodes: true, includeNonVideos: true)
-	 * To search for only single episodes, but exclude season pack episodes (data-based)
-	 *    use (includeEpisodes: false, includeSingleEpisodes: true, includeNonVideos: true)
-	 *
 	 * Whether to search for all episode torrents, including those from season packs. This option overrides includeSingleEpisodes.
 	 */
 	includeEpisodes: false,
 
 	/**
-	 * Search for single episodes (not from season packs)
-	 * during data based searches. 
+	 * Whether to include single episode torrents in the search (not from season packs). 
+	 * Like `includeEpisodes` but slightly more restrictive.
 	 */
 	includeSingleEpisodes: false,
 
 	/**
 	 * Include torrents which contain non-video files
-	 * This option does not override includeEpisodes or
-	 * includeSeasonPackEpisodes.
+	 * This option does not override includeEpisodes or includeSingleEpisodes.
+	 * 
+	 * To search for everything except episodes, use (includeEpisodes: false, includeSingleEpisodes: false, includeNonVideos: true)
+	 * To search for everything including episodes, use (includeEpisodes: true, includeNonVideos: true)
+	 * To search for everything except season pack episodes (data-based)
+	 *    use (includeEpisodes: false, includeSingleEpisodes: true, includeNonVideos: true)
 	 */
 	includeNonVideos: false,
 
@@ -233,7 +232,7 @@ module.exports = {
 	searchTimeout: undefined,
 
 	/**
-	 * The number of searches to be done before stop.
+	 * The number of searches to be done before it stops.
 	 * Combine this with "excludeRecentSearch" and "searchCadence" to smooth long-term API usage patterns.
 	 * Default is no limit.
 	 */