Merge pull request #320 from alvinj/aa-reference-review

Review Reference files (and under-the-hood)

Author: romanowski

modules/build/src/main/scala/scala/build/preprocessing/directives/UsingCustomJarDirectiveHandler.scala

@@ -8,10 +8,13 @@ import scala.build.preprocessing.ScopePath
 
 case object UsingCustomJarDirectiveHandler extends UsingDirectiveHandler {
   def name        = "Custom JAR"
-  def description = "Manually adds JAR to the class path"
-  def usage       = "using jar _path_ | using jars _path1_ _path2_ …"
+  def description = "Manually add JAR(s) to the class path"
+  def usage       = "`using jar `_path_ | `using jars `_path1_ _path2_ …"
   override def usageMd =
-    "`using jar `_path_ | `using jars `_path1_ _path2_ …"
+    """using jar _path_ 
+      |
+      |using jars _path1_ _path2_ …""".stripMargin
+
   override def examples = Seq(
     "using jar \"/Users/alexandre/Library/Caches/Coursier/v1/https/repo1.maven.org/maven2/com/chuusai/shapeless_2.13/2.3.7/shapeless_2.13-2.3.7.jar\""
   )

modules/build/src/main/scala/scala/build/preprocessing/directives/UsingDependencyDirectiveHandler.scala

@@ -12,7 +12,7 @@ import scala.build.{Position, Positioned}
 
 case object UsingDependencyDirectiveHandler extends UsingDirectiveHandler {
   def name             = "Dependency"
-  def description      = "Adds dependencies"
+  def description      = "Add dependencies"
   def usage            = "using lib org:name:ver | using libs org:name:ver org2:name2:ver2"
   override def usageMd = "`using lib `_org_`:`name`:`ver"
   override def examples = Seq(

modules/build/src/main/scala/scala/build/preprocessing/directives/UsingJavaHomeDirectiveHandler.scala

@@ -7,10 +7,13 @@ import scala.build.options.{BuildOptions, JavaOptions}
 import scala.build.preprocessing.ScopePath
 
 case object UsingJavaHomeDirectiveHandler extends UsingDirectiveHandler {
-  def name             = "Java home"
-  def description      = "Sets Java home used to run your application or tests"
-  def usage            = "using java-home|javaHome _path_"
-  override def usageMd = "`using java-home `_path_ | `using javaHome `_path_"
+  def name        = "Java home"
+  def description = "Sets Java home used to run your application or tests"
+  def usage       = "using java-home|javaHome _path_"
+  override def usageMd =
+    """`using java-home `_path_ 
+      |
+      |`using javaHome `_path_""".stripMargin
   override def examples = Seq(
     "using java-home \"/Users/Me/jdks/11\""
   )

modules/build/src/main/scala/scala/build/preprocessing/directives/UsingJavaOptionsDirectiveHandler.scala

@@ -7,10 +7,12 @@ import scala.build.preprocessing.ScopePath
 
 case object UsingJavaOptionsDirectiveHandler extends UsingDirectiveHandler {
   def name        = "Java options"
-  def description = "Adds Java options"
+  def description = "Add Java options"
   def usage       = "using java-opt _options_ | using javaOpt _options_"
   override def usageMd =
-    "`using java-opt `_options_ | `using javaOpt `_options_"
+    """`using java-opt `_options_
+      |
+      |`using javaOpt `_options_""".stripMargin
   override def examples = Seq(
     "using javaOpt -Xmx2g -Dsomething=a"
   )

modules/build/src/main/scala/scala/build/preprocessing/directives/UsingRepositoryDirectiveHandler.scala

@@ -7,7 +7,7 @@ import scala.build.preprocessing.ScopePath
 
 case object UsingRepositoryDirectiveHandler extends UsingDirectiveHandler {
   def name             = "Repository"
-  def description      = "Adds a repository for dependency resolution"
+  def description      = "Add a repository for dependency resolution"
   def usage            = "using repository _repository_"
   override def usageMd = "`using repository `_repository_"
   override def examples = Seq(

modules/build/src/main/scala/scala/build/preprocessing/directives/UsingResourcesDirectiveHandler.scala

@@ -8,10 +8,14 @@ import scala.build.preprocessing.ScopePath
 
 case object UsingResourcesDirectiveHandler extends UsingDirectiveHandler {
   def name        = "Resources"
-  def description = "Manually adds a resource directory to the class path"
-  def usage       = "using resource _path_ | using resources _path1_ _path2_ …"
+  def description = "Manually add a resource directory to the class path"
+  def usage = """using resource _path_
+                |
+                |using resources _path1_ _path2_ …""".stripMargin
   override def usageMd =
-    "`using resource `_path_ | `using resources `_path1_ _path2_ …"
+    """`using resource `_path_
+      |
+      |`using resources `_path1_ _path2_ …""".stripMargin
   override def examples = Seq(
     "using resource \"./resources\""
   )

modules/build/src/main/scala/scala/build/preprocessing/directives/UsingScalaVersionDirectiveHandler.scala

@@ -7,7 +7,7 @@ import scala.build.preprocessing.ScopePath
 
 case object UsingScalaVersionDirectiveHandler extends UsingDirectiveHandler {
   def name             = "Scala version"
-  def description      = "Sets the default Scala version"
+  def description      = "Set the default Scala version"
   def usage            = "using scala _version_+"
   override def usageMd = "`using scala `_version_+"
   override def examples = Seq(

modules/build/src/main/scala/scala/build/preprocessing/directives/UsingTestFrameworkDirectiveHandler.scala

@@ -11,7 +11,7 @@ import scala.build.preprocessing.ScopePath
 
 case object UsingTestFrameworkDirectiveHandler extends UsingDirectiveHandler {
   def name        = "Test framework"
-  def description = "Sets test framework"
+  def description = "Set the test framework"
   def usage       = "using test-framework _class_name_"
   override def usageMd =
     "`using test-framework `_class_name_"

modules/cli/src/main/scala/scala/cli/commands/CleanOptions.scala

@@ -3,7 +3,7 @@ package scala.cli.commands
 import caseapp._
 
 // format: off
-@HelpMessage("Clean-up workspace")
+@HelpMessage("Clean the workspace")
 final case class CleanOptions(
   @Recurse
     logging: LoggingOptions = LoggingOptions(),

modules/cli/src/main/scala/scala/cli/commands/CompileOptions.scala

@@ -17,7 +17,7 @@ final case class CompileOptions(
 
   @Name("p")
   @Name("classpath")
-  @HelpMessage("Print resulting class path")
+  @HelpMessage("Print the resulting class path")
     classPath: Boolean = false
 ) {
   // format: on