Fix incorrect documentation of log_js_error (#129)

SOHELAHMED7 · web-flow · commit 5c2dc45a7a17 · 2024-09-15T22:18:59.000+03:00
#25 (comment)
diff --git a/src/Codeception/Module/WebDriver.php b/src/Codeception/Module/WebDriver.php
@@ -272,7 +272,7 @@
  * * `ssl_proxy` - sets ssl(https) proxy server url for testing a remote server.
  * * `ssl_proxy_port` - sets ssl(https) proxy server port
  * * `debug_log_entries` - how many selenium entries to print with `debugWebDriverLogs` or on fail (0 by default).
- * * `log_js_errors` - Set to true to include possible JavaScript to HTML report, or set to false (default) to deactivate.
+ * * `log_js_errors` - Set to true to include possible JavaScript to HTML report, or set to false (default) to deactivate. This will only work if `debug_log_entries` is set and its value is > 0. Also this will display JS errors as comments only if test fails.
  * * `webdriver_proxy` - sets http proxy to tunnel requests to the remote Selenium WebDriver through
  * * `webdriver_proxy_port` - sets http proxy server port to tunnel requests to the remote Selenium WebDriver through
  *

Original file line number	Diff line number	Diff line change
`@@ -272,7 +272,7 @@`
`272`	`272`	* * `ssl_proxy` - sets ssl(https) proxy server url for testing a remote server.
`273`	`273`	* * `ssl_proxy_port` - sets ssl(https) proxy server port
`274`	`274`	* * `debug_log_entries` - how many selenium entries to print with `debugWebDriverLogs` or on fail (0 by default).
`275`		- * * `log_js_errors` - Set to true to include possible JavaScript to HTML report, or set to false (default) to deactivate.
	`275`	+ * * `log_js_errors` - Set to true to include possible JavaScript to HTML report, or set to false (default) to deactivate. This will only work if `debug_log_entries` is set and its value is > 0. Also this will display JS errors as comments only if test fails.
`276`	`276`	* * `webdriver_proxy` - sets http proxy to tunnel requests to the remote Selenium WebDriver through
`277`	`277`	* * `webdriver_proxy_port` - sets http proxy server port to tunnel requests to the remote Selenium WebDriver through
`278`	`278`	`*`