Fixing comments

Author: nboyer-google

src/main/java/com/pdsl/executors/DefaultPolymorphicDslTestExecutor.java

@@ -192,9 +192,7 @@ public MetadataTestRunResults runTestsWithMetadata(Collection<SharedTestCase> sh
             List<TestCase> listOfTestCases = sharedTestCase.getSharedTestCaseWithInterpreters().stream()
                     .map(SharedTestCaseWithInterpreter::getTestCase).toList();
             int size = listOfTestCases.getFirst().getUnfilteredPhraseBody().size();
-            // The first phrase in a test case has metadata (arbitrarilly decided by standard implementation,
-            // not because it necessarily should be that way)
-            TestCase testCase = listOfTestCases.stream().findFirst().orElseThrow();
+
             notifyBeforeTestCase(sharedTestCase);
             // Create each visitor/listener one time per test case
             Map<InterpreterObj, ParseTreeListener> suppliedListeneres = new HashMap<>();
@@ -258,22 +256,22 @@ public MetadataTestRunResults runTestsWithMetadata(Collection<SharedTestCase> sh
                     }
                     phraseIndex++;
                 }
-                notifyTestCaseSuccess(testCase);
+                notifyTestCaseSuccess(sharedTestCase);
             } catch (Throwable e) {
                 if (interpreterObj.isPresent() && phrase.isPresent()) {
                     if (interpreterObj.get().getParseTreeListener().isPresent()) {
                         notifyOnListenerException(interpreterObj.get().getParseTreeListener().get(),
-                                testSection, testCase, e);
+                                testSection, sharedTestCase, e);
                     } else if (interpreterObj.get().getParseTreeVisitor().isPresent()) {
                         notifyOnVisitorException(interpreterObj.get().getParseTreeVisitor().get(),
-                                testSection, testCase, e);
+                                testSection, sharedTestCase, e);
                     }
                 }
-                results.addTestResult(DefaultTestResult.failedTest(testCase, null, e, phraseIndex,
+                results.addTestResult(DefaultTestResult.failedTest(sharedTestCase, null, e, phraseIndex,
                         size - phraseIndex));
             }
-            results.addTestResult(DefaultTestResult.passingTest(testCase));
-            notifyAfterTestCase(testCase);
+            results.addTestResult(DefaultTestResult.passingTest(sharedTestCase));
+            notifyAfterTestCase(sharedTestCase);
         }
         notifyAfterTestSuite(sharedTestCases, results, context);
         return results;
@@ -298,7 +296,7 @@ public MetadataTestRunResults runTestsWithMetadata(Collection<SharedTestCase> sh
      *                           be called
      * testCaseSuccess         - Called once after each test case only if it had no
      *                           phrase failures
-     * @param observer
+     * @param observer an observer to notify during test execution events
      */
     @Override
     public void registerObserver(ExecutorObserver observer) {

src/main/java/com/pdsl/testcases/TestSection.java

@@ -23,10 +23,17 @@ public interface TestSection {
     /**
      * Provides additional information associated with this test section if found.
      * @return optional of type input stream representing the metadata
+     * @deprecated use getSectionMetadata instead
      */
     @Deprecated
     Optional<InputStream> getMetaData();
 
+    /**
+     * Provides additional information associated with this test section.
+     * <p>
+     * The use of this information, if any, is up to the underlying implementation.
+     * @return map containing arbitrary objects
+     */
     Optional<Map<String, Object>> getSectionMetadata();
 
     /**
@@ -57,5 +64,4 @@ static List<TestSection> convertBodyFragment(TestBodyFragment testBodyFragment)
         }
         return testSections;
     }
-
 }