From 33bb77abd28d3699fda429fef466dcaf40f3a3e3 Mon Sep 17 00:00:00 2001
From: Niels Dossche <7771979+nielsdos@users.noreply.github.com>
Date: Tue, 12 Nov 2024 19:26:25 +0100
Subject: [PATCH] Document tentative return type changes in Phar

---
 reference/phar/Phar/setAlias.xml       | 30 +++++++++++++++++++++++---
 reference/phar/Phar/setDefaultStub.xml | 15 +++++++++----
 2 files changed, 38 insertions(+), 7 deletions(-)

diff --git a/reference/phar/Phar/setAlias.xml b/reference/phar/Phar/setAlias.xml
index 4aa227a7bec9..c6f04e929190 100644
--- a/reference/phar/Phar/setAlias.xml
+++ b/reference/phar/Phar/setAlias.xml
@@ -9,7 +9,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis role="Phar">
-   <modifier>public</modifier> <type>bool</type><methodname>Phar::setAlias</methodname>
+   <modifier>public</modifier> <type>true</type><methodname>Phar::setAlias</methodname>
    <methodparam><type>string</type><parameter>alias</parameter></methodparam>
   </methodsynopsis>
   &phar.write;
@@ -44,8 +44,9 @@
  </refsect1>
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
-  <para>
-  </para>
+  <simpara>
+   &return.true.always;
+  </simpara>
  </refsect1>
 
  <refsect1 role="errors">
@@ -57,6 +58,29 @@
   </para>
  </refsect1>
 
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>8.4.0</entry>
+      <entry>
+       <methodname>Phar::setAlias</methodname>
+       now has a tentative return of <type>true</type>.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>
diff --git a/reference/phar/Phar/setDefaultStub.xml b/reference/phar/Phar/setDefaultStub.xml
index 6b2c19ce5e73..35ac02778564 100644
--- a/reference/phar/Phar/setDefaultStub.xml
+++ b/reference/phar/Phar/setDefaultStub.xml
@@ -8,7 +8,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis role="Phar">
-   <modifier>public</modifier> <type>bool</type><methodname>Phar::setDefaultStub</methodname>
+   <modifier>public</modifier> <type>true</type><methodname>Phar::setDefaultStub</methodname>
    <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>index</parameter><initializer>&null;</initializer></methodparam>
    <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>webIndex</parameter><initializer>&null;</initializer></methodparam>
   </methodsynopsis>
@@ -45,9 +45,9 @@
 
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
-  <para>
-   &return.success;
-  </para>
+  <simpara>
+   &return.true.always;
+  </simpara>
  </refsect1>
 
  <refsect1 role="errors">
@@ -72,6 +72,13 @@
      </row>
     </thead>
     <tbody>
+     <row>
+      <entry>8.4.0</entry>
+      <entry>
+       <methodname>Phar::setDefaultStub</methodname>
+       now has a tentative return of <type>true</type>.
+      </entry>
+     </row>
      <row>
       <entry>8.0.0</entry>
       <entry>