summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Finlay <finlay@src.gnome.org>2004-11-19 05:27:53 +0000
committerJohn Finlay <finlay@src.gnome.org>2004-11-19 05:27:53 +0000
commit81ad4abf7c572b26f8e76a05946ded643cf2ede4 (patch)
tree11eaac14485a6943bd093092e9b87918f252eff7
parente973018fd06774d46b9feddfa549c6bd7f20e6fd (diff)
downloadpygtk-81ad4abf7c572b26f8e76a05946ded643cf2ede4.tar.gz
Document return value differences.
* pygtk-gtkliststore.xml (remove): Document return value differences.
-rw-r--r--docs/reference/ChangeLog4
-rw-r--r--docs/reference/pygtk-gtkliststore.xml16
2 files changed, 15 insertions, 5 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index c29f4c8c..beec6133 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,7 @@
+2004-11-18 John Finlay <finlay@moeraki.com>
+
+ * pygtk-gtkliststore.xml (remove): Document return value differences.
+
2004-11-16 John Finlay <finlay@moeraki.com>
* pygtk2-ref.xml Set pubdate. Bump version number to 2.5.1
diff --git a/docs/reference/pygtk-gtkliststore.xml b/docs/reference/pygtk-gtkliststore.xml
index f34e3722..a7550eb7 100644
--- a/docs/reference/pygtk-gtkliststore.xml
+++ b/docs/reference/pygtk-gtkliststore.xml
@@ -413,17 +413,23 @@ the row</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- (may not be valid)</simpara></listitem>
+ <listitem><simpara><literal>TRUE</literal> if
+<parameter>iter</parameter> is still valid.</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>remove</methodname>() method removes the row
-specified by <parameter>iter</parameter> from the list store. After being
-removed, <parameter>iter</parameter> is set to be the next valid row, or is
+specified by <parameter>iter</parameter> from the list store and returns
+TRUE if <parameter>iter</parameter> is still valid. After being removed,
+<parameter>iter</parameter> is set to be the next valid row, or is
invalidated if it pointed to the last row.</para>
+ <note>
+ <para>Prior to PyGTK 2.4 this method returned a new <link
+linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> that
+is a copy of <parameter>iter</parameter>.</para>
+ </note>
+
</refsect2>
<refsect2 id="method-gtkliststore--insert">