Improve documentation of tests.trigger.cause (#581)

rjust · May 31, 2024 · 796a1bd · 796a1bd
1 parent ed34738
commit 796a1bd
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -208,7 +208,7 @@ all active bug IDs, along with the bug report ID and bug report URL for each.
 |-----------------------|-------------------------------------------------------------------------------------|
 | bug.id                | Assigned bug IDs (included in all results)                                          |
 | project.id            | Assigned project ID                                                                 |
-| project.name          | Original project name                                                            |
+| project.name          | Original project name                                                               |
 | project.build.file    | Location of the Defects4J build file for the project                                |
 | project.vcs           | Version control system used by the project                                          |
 | project.repository    | Location of the project repository                                                  |
@@ -223,8 +223,8 @@ all active bug IDs, along with the bug report ID and bug report URL for each.
 | classes.relevant.src  | Source classes loaded by the JVM when executing all triggering tests                |
 | classes.relevant.test | Test classes loaded by the JVM when executing all triggering tests                  |
 | tests.relevant        | List of relevant tests classes (a test class is relevant if, when executed, the JVM loads at least one of the modified classes) |
-| tests.trigger         | List of test methods that trigger (expose) the bug                                  |
-| tests.trigger.cause   | List of test methods that trigger (expose) the bug, along with the root cause       |
+| tests.trigger         | List of test methods that trigger (expose) the bug, separated by semicolons (`;`)   |
+| tests.trigger.cause   | List of test methods that trigger (expose) the bug, along with the exception thrown.  Each list element has the form "methodName --> exceptionClass[: message]", and list elements are separated by semicolons (`;`) |
 | deprecated.version    | (for deprecated bugs only) Version of Defects4J where a bug was deprecated          |
 | deprecated.reason     | (for deprecated bugs only) Reason for deprecation                                   |