Update ds extension docs for v2.0 by rtheunissen · Pull Request #5493 · php/doc-en

rtheunissen · 2026-04-14T20:09:18Z

Summary

Remove docs for classes removed in v2: Vector, Deque, Stack, Queue, PriorityQueue, Collection, Sequence, Hashable
Add docs for new v2 classes: Seq, Heap, Key
Update Map, Set, Pair docs for v2 API changes
Add missing method docs: getIterator, ArrayAccess methods, __serialize/__unserialize
Fix missing ksorted entry in versions.xml

See ext-ds v2.0.0 changelog for full details on the API changes.

Test plan

Verify XML validates against DocBook schema
Confirm all method pages render correctly on php.net
Cross-check versions.xml entries against documented methods

🤖 Generated with Claude Code

- Remove docs for classes removed in v2: Vector, Deque, Stack, Queue, PriorityQueue, Collection, Sequence, Hashable - Add docs for new v2 classes: Seq, Heap, Key - Update Map, Set, Pair docs for v2 API changes - Add missing method docs: getIterator, ArrayAccess methods, __serialize/__unserialize across all collection classes - Fix missing ksorted entry in versions.xml Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

lacatoire · 2026-04-21T12:58:39Z

+    <varlistentry xml:id="ds-seq.constants.min-capacity">
+     <term><constant>Ds\Seq::MIN_CAPACITY</constant></term>
     <listitem>
      <para></para>


Suggested change

<para></para>

<simpara>The minimum capacity of a <classname>Ds\Seq</classname>.</simpara>

lacatoire · 2026-04-21T12:59:27Z

    <varlistentry xml:id="ds-set.constants.min-capacity">
     <term><constant>Ds\Set::MIN_CAPACITY</constant></term>
     <listitem>
      <para></para>


Suggested change

<simpara>The minimum capacity of a <classname>Ds\Set</classname>.</simpara>

lacatoire · 2026-04-21T13:00:09Z

    <varlistentry xml:id="ds-map.constants.min-capacity">
     <term><constant>Ds\Map::MIN_CAPACITY</constant></term>
     <listitem>
      <para></para>


Suggested change

<simpara>The minimum capacity of a <classname>Ds\Map</classname>.</simpara>

lacatoire · 2026-04-21T13:00:44Z

+    <varlistentry xml:id="ds-heap.constants.min-capacity">
+     <term><constant>Ds\Heap::MIN_CAPACITY</constant></term>
+     <listitem>
+      <para></para>


Suggested change

<para></para>

<simpara>The minimum capacity of a <classname>Ds\Heap</classname>.</simpara>

lacatoire · 2026-04-21T13:47:33Z

-    The name is a common abbreviation of “double-ended queue” and is used
-    internally by <classname>Ds\Queue</classname>.
+    A Seq is an ordered sequence of values in a contiguous buffer that grows
+    and shrinks automatically. It replaces both <classname>Ds\Vector</classname>


Suggested change

and shrinks automatically. It replaces both <classname>Ds\Vector</classname>

and shrinks automatically. It replaces both <literal>Ds\Vector</literal>

lacatoire · 2026-04-21T13:48:38Z

-    internally by <classname>Ds\Queue</classname>.
+    A Seq is an ordered sequence of values in a contiguous buffer that grows
+    and shrinks automatically. It replaces both <classname>Ds\Vector</classname>
+    and <classname>Ds\Deque</classname> from v1.


Suggested change

and <classname>Ds\Deque</classname> from v1.

and <literal>Ds\Deque</literal> from v1.

lacatoire · 2026-04-21T13:54:30Z

+    is provided, the heap behaves as a max-heap using standard comparison.
+   </para>
+   <para>
+    Replaces <classname>Ds\PriorityQueue</classname> from v1, providing more


Suggested change

Replaces <classname>Ds\PriorityQueue</classname> from v1, providing more

Replaces <literal>Ds\PriorityQueue</literal> from v1, providing more

lacatoire · 2026-04-21T13:54:50Z

+   <para>
+    Key is an interface that allows objects to be used as keys in a
+    <classname>Ds\Map</classname> or values in a <classname>Ds\Set</classname>.
+    It replaces <classname>Ds\Hashable</classname> from v1.


Suggested change

It replaces <classname>Ds\Hashable</classname> from v1.

It replaces <literal>Ds\Hashable</literal> from v1.

lacatoire · 2026-04-21T13:55:35Z

+       <row>
+        <entry>PECL ds 2.0.0</entry>
+        <entry>
+         No longer implements <classname>Ds\Collection</classname>.


Suggested change

No longer implements <classname>Ds\Collection</classname>.

No longer implements <literal>Ds\Collection</literal>.

lacatoire · 2026-04-21T13:56:06Z

+       <row>
+        <entry>PECL ds 2.0.0</entry>
+        <entry>
+         No longer implements <classname>Ds\Collection</classname>.


Suggested change

No longer implements <classname>Ds\Collection</classname>.

No longer implements <literal>Ds\Collection</literal>.

lacatoire · 2026-04-21T14:01:32Z

+  <para>
+    &return.void;
+  </para>
+ </refsect1>


Ds\Seq narrows the mixed offset to int at runtime and throws a TypeError otherwise here. Could we add a short <refsect1 role="errors"> here mentioning the TypeError for non-int offsets?

lacatoire · 2026-04-21T15:00:36Z

-    Returns &true; if the deque is empty, &false; otherwise.
+    The value at the given offset.
  </para>
 </refsect1>


Ds\Seq narrows the mixed offset to int at runtime and throws a TypeError otherwise here. Could we add a short <refsect1 role="errors"> here mentioning the TypeError for non-int offsets?

lacatoire · 2026-04-21T15:00:54Z

+  <para>
+    &true; if the offset is valid, &false; otherwise.
+  </para>
+ </refsect1>


Ds\Seq narrows the mixed offset to int at runtime and throws a TypeError otherwise here. Could we add a short <refsect1 role="errors"> here mentioning the TypeError for non-int offsets?

lacatoire · 2026-04-21T15:01:11Z

+  <para>
+    &return.void;
+  </para>
+ </refsect1>


Ds\Seq narrows the mixed offset to int at runtime and throws a TypeError otherwise here. Could we add a short <refsect1 role="errors"> here mentioning the TypeError for non-int offsets?

lacatoire reviewed Apr 21, 2026

View reviewed changes

	<para></para>
	<simpara>The minimum capacity of a <classname>Ds\Seq</classname>.</simpara>

	and shrinks automatically. It replaces both <classname>Ds\Vector</classname>
	and shrinks automatically. It replaces both <literal>Ds\Vector</literal>

	and <classname>Ds\Deque</classname> from v1.
	and <literal>Ds\Deque</literal> from v1.

	Replaces <classname>Ds\PriorityQueue</classname> from v1, providing more
	Replaces <literal>Ds\PriorityQueue</literal> from v1, providing more

	It replaces <classname>Ds\Hashable</classname> from v1.
	It replaces <literal>Ds\Hashable</literal> from v1.

	No longer implements <classname>Ds\Collection</classname>.
	No longer implements <literal>Ds\Collection</literal>.

Conversation

rtheunissen commented Apr 14, 2026

Summary

Test plan

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants