Update documentation for TestStepResult.message (#315)

Better describe TestStepResult.message contents

Author: davidjgoss

CHANGELOG.md

@@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+### Changed
+- Update documentation for `TestStepResult.message` ([#315](https://github.com/cucumber/messages/pull/315))
 
 ## [28.1.0] - 2025-07-21
 ### Added

dotnet/Cucumber.Messages/generated/TestStepResult.cs

@@ -18,7 +18,7 @@ public sealed class TestStepResult
 {
     public Duration Duration { get; private set; }
     /**
-     * An arbitrary bit of information that explains this result. This can be a stack trace of anything else.
+     * An arbitrary bit of information that explains this result. If there was an exception, this should include a stringified representation of it including type, message and stack trace (the exact format will vary by platform).
      */
     public string Message { get; private set; }
     public TestStepResultStatus Status { get; private set; }

java/src/generated/java/io/cucumber/messages/types/TestStepResult.java

@@ -35,7 +35,7 @@ public Duration getDuration() {
     }
 
     /**
-      * An arbitrary bit of information that explains this result. This can be a stack trace of anything else.
+      * An arbitrary bit of information that explains this result. If there was an exception, this should include a stringified representation of it including type, message and stack trace (the exact format will vary by platform).
      */
     public Optional<String> getMessage() {
         return Optional.ofNullable(message);

jsonschema/src/TestStepResult.json

@@ -12,7 +12,7 @@
     },
     "message": {
       "type": "string",
-      "description": "An arbitrary bit of information that explains this result. This can be a stack trace of anything else."
+      "description": "An arbitrary bit of information that explains this result. If there was an exception, this should include a stringified representation of it including type, message and stack trace (the exact format will vary by platform)."
     },
     "status": {
       "enum": [
@@ -32,4 +32,4 @@
     }
   },
   "type": "object"
-}
+}

perl/lib/Cucumber/Messages.pm

@@ -4665,7 +4665,7 @@ has duration =>
 
 =head4 message
 
-An arbitrary bit of information that explains this result. This can be a stack trace of anything else.
+An arbitrary bit of information that explains this result. If there was an exception, this should include a stringified representation of it including type, message and stack trace (the exact format will vary by platform).
 =cut
 
 has message =>

php/src-generated/TestStepResult.php

@@ -28,7 +28,7 @@ public function __construct(
         public readonly Duration $duration = new Duration(),
 
         /**
-         * An arbitrary bit of information that explains this result. This can be a stack trace of anything else.
+         * An arbitrary bit of information that explains this result. If there was an exception, this should include a stringified representation of it including type, message and stack trace (the exact format will vary by platform).
          */
         public readonly ?string $message = null,
         public readonly TestStepResult\Status $status = TestStepResult\Status::UNKNOWN,

python/src/cucumber_messages/_messages.py

@@ -650,7 +650,7 @@ class TestStepResult:
     duration: Duration
     status: TestStepResultStatus
     exception: Optional[Exception] = None  # Exception thrown while executing this step, if any.
-    message: Optional[str] = None  # An arbitrary bit of information that explains this result. This can be a stack trace of anything else.
+    message: Optional[str] = None  # An arbitrary bit of information that explains this result. If there was an exception, this should include a stringified representation of it including type, message and stack trace (the exact format will vary by platform).
 
 
 @dataclass

ruby/lib/cucumber/messages/test_step_result.rb

@@ -11,7 +11,7 @@ class TestStepResult < Message
       attr_reader :duration
 
       ##
-      # An arbitrary bit of information that explains this result. This can be a stack trace of anything else.
+      # An arbitrary bit of information that explains this result. If there was an exception, this should include a stringified representation of it including type, message and stack trace (the exact format will vary by platform).
       ##
       attr_reader :message