fix passesConditionForErroringBestEffortCode and improve doc comments

Author: jchyb

compiler/src/dotty/tools/dotc/core/tasty/TreePickler.scala

@@ -66,15 +66,16 @@ class TreePickler(pickler: TastyPickler, attributes: Attributes) {
     fillRef(lengthAddr, currentAddr, relative = true)
   }
 
-  /** There are certain expectations with code which is naturally able to reach pickling
-   *  phase as opposed to one that uses best-effort compilation features.
-   *  When pickling betasty files, we do some custom checks, in case those expectations
-   *  cannot be fulfilled, and if then we can try to do something else.
-   *  For regular non best-effort compilation (without best-effort and without using .betasty on classpath),
-   *  this will always return true.
+  /** There are certain expectations with code which is naturally able to reach
+   *  pickling phase as opposed to one that uses best-effort compilation features.
+   *  When pickling betasty files, we do some custom checks, in case those
+   *  expectations cannot be fulfilled, and if so, then we can try to do something
+   *  else (usually pickle an ERRORtype).
+   *  For regular non best-effort compilation (without -Ybest-effort with thrown errors
+   *  and without using .betasty on classpath), this will always return true.
    */
   private inline def passesConditionForErroringBestEffortCode(condition: => Boolean)(using Context): Boolean =
-    ((!ctx.isBestEffort && ctx.reporter.errorsReported) || ctx.usedBestEffortTasty) || condition
+    !((ctx.isBestEffort && ctx.reporter.errorsReported) || ctx.usedBestEffortTasty) || condition
 
   def addrOfSym(sym: Symbol): Option[Addr] =
     symRefs.get(sym)

compiler/src/dotty/tools/dotc/transform/Pickler.scala

@@ -62,7 +62,8 @@ class Pickler extends Phase {
     (super.isRunnable || ctx.isBestEffort)
     && !ctx.settings.fromTasty.value
     && (!ctx.usedBestEffortTasty || ctx.isBestEffort)
-    // we do not want to pickle `.betasty` if will not create the file either way
+    // we do not want to pickle `.betasty` if do not plan to actually create the
+    // betasty file (as signified by the -Ybest-effort option)
 
   // when `-Yjava-tasty` is set we actually want to run this phase on Java sources
   override def skipIfJava(using Context): Boolean = false