Fix GH-2639: Mention empty needle in string functions

php · Aug 7, 2023 · 45846ac · 45846ac
1 parent 660cdbf
commit 45846ac
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 2 deletions.
diff --git a/language-snippets.ent b/language-snippets.ent
@@ -3947,6 +3947,13 @@ local: {
  </para>
 '>
 
+<!ENTITY strings.changelog.needle-empty '<row xmlns="http://docbook.org/ns/docbook">
+ <entry>8.0.0</entry>
+ <entry>
+  <parameter>needle</parameter> now accepts an empty string.
+ </entry>
+</row>'>
+
 <!ENTITY strings.changelog.encoding '
  <row xmlns="http://docbook.org/ns/docbook">
   <entry>5.6.0</entry>

diff --git a/reference/strings/functions/stripos.xml b/reference/strings/functions/stripos.xml
@@ -40,8 +40,7 @@
      <term><parameter>needle</parameter></term>
      <listitem>
       <para>
-       Note that the <parameter>needle</parameter> may be a string of one or
-       more characters.
+       The string to search for.
       </para>
       &strings.parameter.needle.non-string;
      </listitem>
@@ -85,6 +84,7 @@
     </thead>
     <tbody>
      &strings.changelog.ascii-case-folding;
+     &strings.changelog.needle-empty;
      <row>
       <entry>8.0.0</entry>
       <entry>

diff --git a/reference/strings/functions/stristr.xml b/reference/strings/functions/stristr.xml
@@ -35,6 +35,9 @@
     <varlistentry>
      <term><parameter>needle</parameter></term>
      <listitem>
+      <para>
+       The string to search for.
+      </para>
       &strings.parameter.needle.non-string;
      </listitem>
     </varlistentry>

diff --git a/reference/strings/functions/strpos.xml b/reference/strings/functions/strpos.xml
@@ -35,6 +35,9 @@
     <varlistentry>
      <term><parameter>needle</parameter></term>
      <listitem>
+      <para>
+       The string to search for.
+      </para>
       &strings.parameter.needle.non-string;
      </listitem>
     </varlistentry>
@@ -76,6 +79,7 @@
      </row>
     </thead>
     <tbody>
+     &strings.changelog.needle-empty;
      <row>
       <entry>8.0.0</entry>
       <entry>

diff --git a/reference/strings/functions/strrchr.xml b/reference/strings/functions/strrchr.xml
@@ -66,6 +66,7 @@
      </row>
     </thead>
     <tbody>
+     &strings.changelog.needle-empty;
      <row>
       <entry>8.0.0</entry>
       <entry>

diff --git a/reference/strings/functions/strripos.xml b/reference/strings/functions/strripos.xml
@@ -39,6 +39,9 @@
     <varlistentry>
      <term><parameter>needle</parameter></term>
      <listitem>
+      <para>
+       The string to search for.
+      </para>
       &strings.parameter.needle.non-string;
      </listitem>
     </varlistentry>
@@ -99,6 +102,7 @@
     </thead>
     <tbody>
      &strings.changelog.ascii-case-folding;
+     &strings.changelog.needle-empty;
      <row>
       <entry>8.0.0</entry>
       <entry>

diff --git a/reference/strings/functions/strrpos.xml b/reference/strings/functions/strrpos.xml
@@ -35,6 +35,9 @@
     <varlistentry>
      <term><parameter>needle</parameter></term>
      <listitem>
+      <para>
+       The string to search for.
+      </para>
       &strings.parameter.needle.non-string;
      </listitem>
     </varlistentry>
@@ -94,6 +97,7 @@
      </row>
     </thead>
     <tbody>
+     &strings.changelog.needle-empty;
      <row>
       <entry>8.0.0</entry>
       <entry>

diff --git a/reference/strings/functions/strstr.xml b/reference/strings/functions/strstr.xml
@@ -49,6 +49,9 @@
     <varlistentry>
      <term><parameter>needle</parameter></term>
      <listitem>
+      <para>
+       The string to search for.
+      </para>
       &strings.parameter.needle.non-string;
      </listitem>
     </varlistentry>
@@ -86,6 +89,7 @@
       </row>
      </thead>
      <tbody>
+      &strings.changelog.needle-empty;
       <row>
        <entry>8.0.0</entry>
        <entry>