tweaks

Author: lihaoyi

build.sc

@@ -122,7 +122,7 @@ trait ExampleParseJvmModule extends CommonCrossModule{
 
 trait CommonCrossModule extends CrossScalaModule with PublishModule{
 
-  def publishVersion = "2.0.0"
+  def publishVersion = "2.0.1"
   def artifactName = millModuleSegments.parts.dropRight(2).mkString("-")
   def pomSettings = PomSettings(
     description = artifactName(),
@@ -138,7 +138,7 @@ trait CommonCrossModule extends CrossScalaModule with PublishModule{
     )
   )
 
-  def scalaDocPluginClasspath = T{ Agg() }
+  def scalaDocPluginClasspath = T{ Agg[PathRef]() }
   def scalacOptions = T{ if (scalaVersion() == "2.12.7") Seq("-opt:l:method") else Nil }
 
   def platformSegment: String

fastparse/src/fastparse/Parsed.scala

@@ -25,11 +25,29 @@ object Parsed{
       Parsed.Extra(p.input, p.startIndex, p.index, p.originalParser, p.failureStack)
     )
   }
+
+  /**
+    * The outcome of a successful parse
+    *
+    * @param value The value returned by the parse
+    * @param index The index at which the parse completed at
+    */
   final case class Success[+T](value: T, index: Int) extends Parsed[T](true){
     def get = this
     def fold[V](onFailure: (String, Int, Extra) => V, onSuccess: (T, Int) => V) = onSuccess(value, index)
     override def toString() = s"Parsed.Success($value, $index)"
   }
+
+  /**
+    * The outcome of a failed parse
+    *
+    * @param failureLabel A hint as to why the parse failed. Defaults to "",
+    *                     unless you set `verboseFailures = true` or call
+    *                     `.trace()` on an existing failure
+    * @param index The index at which the parse failed
+    * @param extra Metadata about the parse; useful for re-running the parse
+    *              to trace out a more detailed error report
+    */
   final case class Failure(failureLabel: String,
                            index: Int,
                            extra: Extra) extends Parsed[Nothing](false){
@@ -122,6 +140,18 @@ object Parsed{
       )
     }
   }
+
+  /**
+    * A decorated [[Failure]] with extra metadata; provides a much more
+    * detailed, through verbose, of the possible inputs that may have been
+    * expected at the index at which the parse failed.
+    *
+    * @param failureAggregate contains not just the parsers which were present
+    *                         when the parse finally failed, but also any other
+    *                         parsers which may have earlier been tried at the
+    *                         same index.
+    * @param failure The raw failure object
+    */
   case class TracedFailure(failureAggregate: Seq[String],
                            failure: Failure){
     def failureLabel = failure.failureLabel
@@ -135,9 +165,13 @@ object Parsed{
 
     @deprecated("Use .msg instead")
     def trace = longAggregateMsg
-
+    /**
+      * Displays the failure message excluding the parse stack
+      */
     def msg = failure.msg
-
+    /**
+      * Displays the failure message including the parse stack, if possible
+      */
     def longMsg = failure.longMsg
     /**
       * Displays the aggregate failure message, excluding the parse stack

readme/Changelog.scalatex

@@ -1,6 +1,6 @@
 @import Main._
 @sect{Change Log}
-    @sect{2.0.0}
+    @sect{2.0.1}
         @ul
             @li
                 Major rewrite of @sect.ref{Internals} with some changes to

readme/ExampleParsers.scalatex

@@ -193,13 +193,13 @@
             To begin using ScalaParse, add
 
             @hl.scala
-                "com.lihaoyi" %% "scalaparse" % "2.0.0"
+                "com.lihaoyi" %% "scalaparse" % "2.0.1"
 
             @p
                 To your SBT configuration. To use with Scala.js, you'll need
 
             @hl.scala
-                "com.lihaoyi" %%% "scalaparse" % "2.0.0"
+                "com.lihaoyi" %%% "scalaparse" % "2.0.1"
 
     @sect{PythonParse}
         @div(id := "pythondiv")
@@ -211,7 +211,7 @@
             PythonParse is currently compatible enough to parse all the python sources in Zulip, Ansible, Changes, Django, and Flask. It isn't published yet on maven central, but feel free to look at it if you want an idea of how to write a complex, real parser.
 
         @hl.scala
-            "com.lihaoyi" %%% "pythonparse" % "2.0.0"
+            "com.lihaoyi" %%% "pythonparse" % "2.0.1"
 
     @sect{CssParse}
         @p
@@ -249,4 +249,4 @@
             This is available on Maven Central as
 
         @hl.scala
-            "com.lihaoyi" %%% "cssparse" % "2.0.0"
+            "com.lihaoyi" %%% "cssparse" % "2.0.1"

readme/FastParseInternals.scalatex

@@ -1,7 +1,7 @@
 @import Main._
 @sect{Internals}
     @p
-        FastParse 2.0.0 is implemented as a set of methods that perform a
+        FastParse 2.0.1 is implemented as a set of methods that perform a
         recursive-descent parse on the given input, with all book-keeping
         information maintained in the @code{fastparse.ParsingRun[T]} objects
         (abbreviated @code{fastparse.P[T]}). @code{ParsingRun}s are mutable,

readme/GettingStarted.scalatex

@@ -42,12 +42,12 @@
         To begin using FastParse, add the following to your build config
 
     @hl.scala
-        "com.lihaoyi" %% "fastparse" % "2.0.0" // SBT
-        ivy"com.lihaoyi::fastparse:2.0.0" // Mill
+        "com.lihaoyi" %% "fastparse" % "2.0.1" // SBT
+        ivy"com.lihaoyi::fastparse:2.0.1" // Mill
 
     @p
         To use with Scala.js, you'll need
     @hl.scala
-        "com.lihaoyi" %%% "fastparse" % "2.0.0" // SBT
-        ivy"com.lihaoyi::fastparse::2.0.0" // Mill
+        "com.lihaoyi" %%% "fastparse" % "2.0.1" // SBT
+        ivy"com.lihaoyi::fastparse::2.0.1" // Mill
 

readme/Readme.scalatex

@@ -20,7 +20,7 @@
   )
 )
 
-@sect("FastParse 2.0.0", "Fast to write, Fast running Parsers in Scala")
+@sect("FastParse 2.0.1", "Fast to write, Fast running Parsers in Scala")
     @GettingStarted()
 
     @WritingParsers()