Add --timeout notice (#557)

Winterhuman · andrews05 · web-flow · commit fa47c82617c8 · 2023-09-26T09:43:38.000+13:00
Closes: #556 Adds a statement saying that `--timeout` isn't as useful for compression algorithms which use fewer and slower rounds, which OxiPNG tends to use nowadays. --------- Co-authored-by: andrews05 <andrew@digerati.co.nz>
diff --git a/src/main.rs b/src/main.rs
@@ -257,7 +257,7 @@ fn main() {
         )
         .arg(
             Arg::new("timeout")
-                .help("Maximum amount of time, in seconds, to spend on optimizations")
+                .help("Maximum amount of time, in seconds, to spend on optimizations (currently of limited use due to the shift away from zlib)")
                 .value_name("secs")
                 .long("timeout")
                 .value_parser(value_parser!(u64)),

Original file line number	Diff line number	Diff line change
`@@ -257,7 +257,7 @@ fn main() {`
`257`	`257`	`)`
`258`	`258`	`.arg(`
`259`	`259`	`Arg::new("timeout")`
`260`		`- .help("Maximum amount of time, in seconds, to spend on optimizations")`
	`260`	`+ .help("Maximum amount of time, in seconds, to spend on optimizations (currently of limited use due to the shift away from zlib)")`
`261`	`261`	`.value_name("secs")`
`262`	`262`	`.long("timeout")`
`263`	`263`	`.value_parser(value_parser!(u64)),`