From 1c84052622db39c6d2eee35ed1820cb52d7b1778 Mon Sep 17 00:00:00 2001
From: David Buchmann <david.buchmann@liip.ch>
Date: Fri, 11 Feb 2022 14:34:02 +0100
Subject: [PATCH] phpdoc for the new method

---
 src/Formatter.php                          | 3 +++
 src/Formatter/CurlCommandFormatter.php     | 4 +++-
 src/Formatter/FullHttpMessageFormatter.php | 4 +++-
 src/Formatter/SimpleFormatter.php          | 4 +++-
 4 files changed, 12 insertions(+), 3 deletions(-)

diff --git a/src/Formatter.php b/src/Formatter.php
index b8cf7b4..6ef70bb 100644
--- a/src/Formatter.php
+++ b/src/Formatter.php
@@ -10,6 +10,9 @@
  *
  * @author Márk Sági-Kazár <mark.sagikazar@gmail.com>
  *
+ * The formatResponseForRequest method will be added to this interface in the next major version, replacing the formatRequest method.
+ * Meanwhile, callers SHOULD check the formatter for the existence of formatResponseForRequest and call that if available.
+ *
  * @method string formatResponseForRequest(ResponseInterface $response, RequestInterface $request) Formats a response in context of its request.
  */
 interface Formatter
diff --git a/src/Formatter/CurlCommandFormatter.php b/src/Formatter/CurlCommandFormatter.php
index 31f5e7b..80d2971 100644
--- a/src/Formatter/CurlCommandFormatter.php
+++ b/src/Formatter/CurlCommandFormatter.php
@@ -69,7 +69,9 @@ public function formatResponse(ResponseInterface $response)
     }
 
     /**
-     * {@inheritdoc}
+     * Formats a response in context of its request.
+     *
+     * @return string
      */
     public function formatResponseForRequest(ResponseInterface $response, RequestInterface $request)
     {
diff --git a/src/Formatter/FullHttpMessageFormatter.php b/src/Formatter/FullHttpMessageFormatter.php
index 451f667..8b9b126 100644
--- a/src/Formatter/FullHttpMessageFormatter.php
+++ b/src/Formatter/FullHttpMessageFormatter.php
@@ -75,7 +75,9 @@ public function formatResponse(ResponseInterface $response)
     }
 
     /**
-     * {@inheritdoc}
+     * Formats a response in context of its request.
+     *
+     * @return string
      */
     public function formatResponseForRequest(ResponseInterface $response, RequestInterface $request)
     {
diff --git a/src/Formatter/SimpleFormatter.php b/src/Formatter/SimpleFormatter.php
index cfdfef9..ee99ae3 100644
--- a/src/Formatter/SimpleFormatter.php
+++ b/src/Formatter/SimpleFormatter.php
@@ -41,7 +41,9 @@ public function formatResponse(ResponseInterface $response)
     }
 
     /**
-     * {@inheritdoc}
+     * Formats a response in context of its request.
+     *
+     * @return string
      */
     public function formatResponseForRequest(ResponseInterface $response, RequestInterface $request)
     {