Fix added missing quotation marks in examples (#10250)

boris779 · diemol · web-flow · commit deeaa7163510 · 2022-01-20T08:29:46.000-05:00
Co-authored-by: Diego Molina &lt;diemol@users.noreply.github.com&gt;
diff --git a/java/src/org/openqa/selenium/grid/log/LoggingFlags.java b/java/src/org/openqa/selenium/grid/log/LoggingFlags.java
@@ -66,17 +66,17 @@ public class LoggingFlags implements HasRoles {
 
   @Parameter(description = "File to write out logs. "
                            + "Ensure the file path is compatible with the operating system's file path.\n"
-                           + "Windows path example : \\\\path\\to\\file\\gridlog.log OR "
+                           + "# Windows path example : \\\\path\\to\\file\\gridlog.log OR "
                            + "C:\\path\\path\\to\\file\\gridlog.log \n"
-                           + "Linux/Unix/MacOS path example : /path/to/file/gridlog.log \n"
+                           + "# Linux/Unix/MacOS path example : /path/to/file/gridlog.log \n"
     , names = "--log", arity = 1)
   @ConfigValue(section = LOGGING_SECTION, name = "log-file", example = {"'\\\\path\\to\\file\\gridlog.log'",
                                                                         "'C:\\path\\path\\to\\file\\gridlog.log'",
                                                                         "'/path/to/file/gridlog.log'"})
   private String logFile;
 
   @Parameter(description = "Log encoding", names = "--log-encoding", arity = 1)
-  @ConfigValue(section = LOGGING_SECTION, name = "log-encoding", example = "UTF-8")
+  @ConfigValue(section = LOGGING_SECTION, name = "log-encoding", example = "\"UTF-8\"")
   private String logEncoding;
 
   @Parameter(description =
diff --git a/java/src/org/openqa/selenium/grid/node/config/NodeFlags.java b/java/src/org/openqa/selenium/grid/node/config/NodeFlags.java
@@ -145,9 +145,9 @@ public class NodeFlags implements HasRoles {
               "display-name = \"Firefox Nightly\"\n" +
               "webdriver-executable = \"/usr/local/bin/geckodriver\"\n" +
               "max-sessions = 2\n" +
-              "stereotype = \"{\"browserName\": \"firefox\", \"browserVersion\": \"86\", " +
-              "\"moz:firefoxOptions\": " +
-              "{\"binary\":\"/Applications/Firefox Nightly.app/Contents/MacOS/firefox-bin\"}}\"")
+              "stereotype = \"{\\\"browserName\\\": \\\"firefox\\\", \\\"browserVersion\\\": \\\"86\\\", " +
+              "\\\"moz:firefoxOptions\\\": " +
+              "{\\\"binary\\\":\\\"/Applications/Firefox Nightly.app/Contents/MacOS/firefox-bin\\\"}}\"")
   public List<String> driverConfiguration;
 
   @Parameter(
diff --git a/java/src/org/openqa/selenium/grid/node/docker/DockerFlags.java b/java/src/org/openqa/selenium/grid/node/docker/DockerFlags.java
@@ -40,7 +40,7 @@ public class DockerFlags implements HasRoles {
     names = {"--docker-url"},
     description = "URL for connecting to the docker daemon"
   )
-  @ConfigValue(section = DockerOptions.DOCKER_SECTION, name = "url", example = DockerOptions.DEFAULT_DOCKER_URL)
+  @ConfigValue(section = DockerOptions.DOCKER_SECTION, name = "url", example = "\"" + DockerOptions.DEFAULT_DOCKER_URL + "\"")
   private String dockerUrl;
 
   @Parameter(
@@ -81,7 +81,7 @@ public class DockerFlags implements HasRoles {
     names = {"--docker-assets-path"},
     description = "Absolute path where assets will be stored"
   )
-  @ConfigValue(section = DockerOptions.DOCKER_SECTION, name = "assets-path", example = DockerOptions.DEFAULT_ASSETS_PATH)
+  @ConfigValue(section = DockerOptions.DOCKER_SECTION, name = "assets-path", example = "\"" + DockerOptions.DEFAULT_ASSETS_PATH + "\"")
   private String assetsPath;
 
   @Override
diff --git a/java/src/org/openqa/selenium/grid/node/relay/RelayFlags.java b/java/src/org/openqa/selenium/grid/node/relay/RelayFlags.java
@@ -54,16 +54,16 @@ public class RelayFlags implements HasRoles {
     prefixed = true,
     example = "\n" +
               "max-sessions = 2\n" +
-              "stereotype = \"{\"browserName\": \"safari\", \"platformName\": \"iOS\", " +
-              "\"appium:platformVersion\": \"14.5\" }}\"")
+              "stereotype = \"{\\\"browserName\\\": \\\"safari\\\", \\\"platformName\\\": \\\"iOS\\\", " +
+              "\\\"appium:platformVersion\\\": \\\"14.5\\\" }}\"")
   public List<String> driverConfiguration;
 
   @Parameter(
     names = {"--service-url"},
     description = "URL for connecting to the service that supports WebDriver commands, "
                   + "like an Appium server or a cloud service."
   )
-  @ConfigValue(section = RELAY_SECTION, name = "url", example = "http://localhost:4723")
+  @ConfigValue(section = RELAY_SECTION, name = "url", example = "\"http://localhost:4723\"")
   private String serviceUrl;
   @Parameter(
     names = {"--service-host"},
diff --git a/java/src/org/openqa/selenium/grid/server/EventBusFlags.java b/java/src/org/openqa/selenium/grid/server/EventBusFlags.java
@@ -64,7 +64,7 @@ public class EventBusFlags implements HasRoles {
   @ConfigValue(
     section = EVENTS_SECTION,
     name = "implementation",
-    example = "org.openqa.selenium.events.zeromq.ZeroMqEventBus")
+    example = "\"org.openqa.selenium.events.zeromq.ZeroMqEventBus\"")
   private String implementation;
 
   @Override
