Remove unsupported kabe-case style in using directives (#1878)

VirtusLab · Feb 27, 2023 · 7fa41b9 · 7fa41b9
1 parent e689734
commit 7fa41b9
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 39 deletions.
diff --git a/modules/directives/src/main/scala/scala/build/preprocessing/directives/JavaHome.scala b/modules/directives/src/main/scala/scala/build/preprocessing/directives/JavaHome.scala
@@ -9,12 +9,10 @@ import scala.cli.commands.SpecificationLevel
 import scala.util.{Failure, Success, Try}
 
 @DirectiveGroupName("Java home")
-@DirectiveExamples("//> using java-home \"/Users/Me/jdks/11\"")
+@DirectiveExamples("//> using javaHome \"/Users/Me/jdks/11\"")
 @DirectiveUsage(
-  "//> using java-home|javaHome _path_",
-  """`//> using java-home `_path_
-    |
-    |`//> using javaHome `_path_""".stripMargin
+  "//> using javaHome _path_",
+  "`//> using javaHome `_path_"
 )
 @DirectiveDescription("Sets Java home used to run your application or tests")
 @DirectiveLevel(SpecificationLevel.SHOULD)

diff --git a/modules/directives/src/main/scala/scala/build/preprocessing/directives/JavaOptions.scala b/modules/directives/src/main/scala/scala/build/preprocessing/directives/JavaOptions.scala
@@ -9,10 +9,8 @@ import scala.cli.commands.SpecificationLevel
 @DirectiveGroupName("Java options")
 @DirectiveExamples("//> using javaOpt \"-Xmx2g\", \"-Dsomething=a\"")
 @DirectiveUsage(
-  "//> using java-opt _options_ | //> using javaOpt _options_",
-  """`//> using java-opt `_options_
-    |
-    |`//> using javaOpt `_options_""".stripMargin
+  "//> using javaOpt _options_",
+  "`//> using javaOpt `_options_"
 )
 @DirectiveDescription("Add Java options which will be passed when running an application.")
 @DirectiveLevel(SpecificationLevel.MUST)

diff --git a/modules/directives/src/main/scala/scala/build/preprocessing/directives/JavaProps.scala b/modules/directives/src/main/scala/scala/build/preprocessing/directives/JavaProps.scala
@@ -9,7 +9,7 @@ import scala.cli.commands.SpecificationLevel
 @DirectiveGroupName("Java properties")
 @DirectiveExamples("//> using javaProp \"foo1=bar\", \"foo2\"")
 @DirectiveUsage(
-  "//> using java-prop|javaProp _key=val_",
+  "//> using javaProp _key=val_",
   """`//> using javaProp `_key=value_
     |`//> using javaProp `_key_""".stripMargin
 )

diff --git a/modules/directives/src/main/scala/scala/build/preprocessing/directives/JavacOptions.scala b/modules/directives/src/main/scala/scala/build/preprocessing/directives/JavacOptions.scala
@@ -9,10 +9,8 @@ import scala.cli.commands.SpecificationLevel
 @DirectiveGroupName("Javac options")
 @DirectiveExamples("//> using javacOpt \"source\", \"1.8\", \"target\", \"1.8\"")
 @DirectiveUsage(
-  "//> using javac-opt _options_ | //> using javacOpt _options_",
-  """`//> using javac-opt `_options_
-    |
-    |`//> using javacOpt `_options_""".stripMargin
+  "//> using javacOpt _options_",
+  "`//> using javacOpt `_options_"
 )
 @DirectiveDescription("Add Javac options which will be passed when compiling sources.")
 @DirectiveLevel(SpecificationLevel.SHOULD)

diff --git a/modules/directives/src/main/scala/scala/build/preprocessing/directives/MainClass.scala b/modules/directives/src/main/scala/scala/build/preprocessing/directives/MainClass.scala
@@ -7,12 +7,10 @@ import scala.build.{Logger, Positioned, options}
 import scala.cli.commands.SpecificationLevel
 
 @DirectiveGroupName("Main class")
-@DirectiveExamples("//> using main-class \"helloWorld\"")
+@DirectiveExamples("//> using mainClass \"helloWorld\"")
 @DirectiveUsage(
-  "//> using main-class _main class_ | //> using mainClass _main class_",
-  """`//> using main-class `_main class_
-    |
-    |`//> using mainClass `_main class_""".stripMargin
+  "//> using mainClass _main class_",
+  "`//> using mainClass `_main class_"
 )
 @DirectiveDescription("Specify default main class")
 @DirectiveLevel(SpecificationLevel.MUST)

diff --git a/website/docs/reference/directives.md b/website/docs/reference/directives.md
@@ -79,19 +79,15 @@ Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`
 
 Sets Java home used to run your application or tests
 
-`//> using java-home `_path_
-
 `//> using javaHome `_path_
 
 #### Examples
-`//> using java-home "/Users/Me/jdks/11"`
+`//> using javaHome "/Users/Me/jdks/11"`
 
 ### Java options
 
 Add Java options which will be passed when running an application.
 
-`//> using java-opt `_options_
-
 `//> using javaOpt `_options_
 
 #### Examples
@@ -111,8 +107,6 @@ Add Java properties
 
 Add Javac options which will be passed when compiling sources.
 
-`//> using javac-opt `_options_
-
 `//> using javacOpt `_options_
 
 #### Examples
@@ -122,12 +116,10 @@ Add Javac options which will be passed when compiling sources.
 
 Specify default main class
 
-`//> using main-class `_main class_
-
 `//> using mainClass `_main class_
 
 #### Examples
-`//> using main-class "helloWorld"`
+`//> using mainClass "helloWorld"`
 
 ### Packaging
 

diff --git a/website/docs/reference/scala-command/directives.md b/website/docs/reference/scala-command/directives.md
@@ -50,8 +50,6 @@ Add dependencies
 
 Add Java options which will be passed when running an application.
 
-`//> using java-opt `_options_
-
 `//> using javaOpt `_options_
 
 #### Examples
@@ -71,12 +69,10 @@ Add Java properties
 
 Specify default main class
 
-`//> using main-class `_main class_
-
 `//> using mainClass `_main class_
 
 #### Examples
-`//> using main-class "helloWorld"`
+`//> using mainClass "helloWorld"`
 
 ### Scala version
 
@@ -134,19 +130,15 @@ Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`
 
 Sets Java home used to run your application or tests
 
-`//> using java-home `_path_
-
 `//> using javaHome `_path_
 
 #### Examples
-`//> using java-home "/Users/Me/jdks/11"`
+`//> using javaHome "/Users/Me/jdks/11"`
 
 ### Javac options
 
 Add Javac options which will be passed when compiling sources.
 
-`//> using javac-opt `_options_
-
 `//> using javacOpt `_options_
 
 #### Examples