[pygobject] Fix a few uses of TRUE and FALSE in the docs
- From: John Palmieri <johnp src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pygobject] Fix a few uses of TRUE and FALSE in the docs
- Date: Thu, 23 Sep 2010 19:39:24 +0000 (UTC)
commit d6721a59c294f2471142b8c32de2f647b7084bca
Author: Paul Bolle <pebolle tiscali nl>
Date: Thu Sep 23 15:38:40 2010 -0400
Fix a few uses of TRUE and FALSE in the docs
docs/reference/pygio-mount.xml | 5 +++--
docs/reference/pyglib-functions.xml | 18 +++++++++---------
docs/reference/pyglib-maincontext.xml | 12 ++++++------
docs/reference/pyglib-mainloop.xml | 6 +++---
docs/reference/pygobject-functions.xml | 6 +++---
docs/reference/pygobject.xml | 4 ++--
6 files changed, 26 insertions(+), 25 deletions(-)
---
diff --git a/docs/reference/pygio-mount.xml b/docs/reference/pygio-mount.xml
index aa635d4..f01b155 100644
--- a/docs/reference/pygio-mount.xml
+++ b/docs/reference/pygio-mount.xml
@@ -536,11 +536,12 @@
</simpara></listitem>
</varlistentry>
</variablelist>
-
+
+ <!-- XXX This description must be incorrect! -->
<para>
The <methodname>guess_content_type_finish</methodname>() method finishes guessing content
types of mount. If any errors occured during the operation, error will be set to
- contain the errors and FALSE will be returned. In particular, you may get an
+ contain the errors and <literal>False</literal> will be returned. In particular, you may get an
gio.ERROR_NOT_SUPPORTED if the mount does not support content guessing.
</para>
</refsect2>
diff --git a/docs/reference/pyglib-functions.xml b/docs/reference/pyglib-functions.xml
index 358fa83..3e11251 100644
--- a/docs/reference/pyglib-functions.xml
+++ b/docs/reference/pyglib-functions.xml
@@ -148,7 +148,7 @@ loop. The function is given the default idle priority,
pass to <parameter>callback</parameter> can be specified after
<parameter>callback</parameter>. The idle priority can be specified as a
keyword-value pair with the keyword "priority". If
-<parameter>callback</parameter> returns <literal>FALSE</literal> it is
+<parameter>callback</parameter> returns <literal>False</literal> it is
automatically removed from the list of event sources and will not be called
again.</para>
@@ -194,7 +194,7 @@ arguments to pass to <parameter>callback</parameter> can be specified after
keyword-value pair with the keyword "priority".</para>
<para>The function is called repeatedly until it returns
-<literal>FALSE</literal>, at which point the timeout is automatically
+<literal>False</literal>, at which point the timeout is automatically
destroyed and the function will not be called again. The first call to the
function will be at the end of the first interval. Note that timeout
functions may be delayed, due to the processing of other event sources. Thus
@@ -355,9 +355,9 @@ signal; and, <parameter>...</parameter> are the zero or more arguments that
were passed to the <function>glib.io_add_watch</function>()
function.</para>
- <para>If the callback function returns <literal>FALSE</literal> it
+ <para>If the callback function returns <literal>False</literal> it
will be automatically removed from the list of event sources and will not be
-called again. If it returns <literal>TRUE</literal> it will be called again
+called again. If it returns <literal>True</literal> it will be called again
when the condition is matched.</para>
</refsect2>
@@ -376,7 +376,7 @@ when the condition is matched.</para>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara><literal>TRUE</literal> if the event source was
+ <listitem><simpara><literal>True</literal> if the event source was
removed</simpara></listitem>
</varlistentry>
</variablelist>
@@ -553,17 +553,17 @@ calling <function>exec</function>()</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">standard_input</parameter> :</term>
- <listitem><simpara>if <literal>TRUE</literal> return the file
+ <listitem><simpara>if <literal>True</literal> return the file
descriptor for the child's stdin</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">standard_output</parameter> :</term>
- <listitem><simpara>if <literal>TRUE</literal> return the file
+ <listitem><simpara>if <literal>True</literal> return the file
descriptor for the child's stdout</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">standard_error</parameter> :</term>
- <listitem><simpara>if <literal>TRUE</literal> return the file
+ <listitem><simpara>if <literal>True</literal> return the file
descriptor for the child's stderr</simpara></listitem>
</varlistentry>
<varlistentry>
@@ -591,7 +591,7 @@ and stderr. The stdin, stdout and stderr file descriptors are returned only
ofthe corresponding <parameter>standard_input</parameter>,
<parameter>standard_output</parameter> or
<parameter>standard_error</parameter> params are
-<literal>TRUE</literal>.</para>
+<literal>True</literal>.</para>
<para>On Windows, the low-level child process creation API
(<function>CreateProcess</function>()) doesn't use argument vectors, but a
diff --git a/docs/reference/pyglib-maincontext.xml b/docs/reference/pyglib-maincontext.xml
index ccb91bb..ee1e985 100644
--- a/docs/reference/pyglib-maincontext.xml
+++ b/docs/reference/pyglib-maincontext.xml
@@ -91,12 +91,12 @@ object.</para>
<variablelist>
<varlistentry>
<term><parameter>may_block</parameter> :</term>
- <listitem><simpara>if <literal>TRUE</literal> the call may block
+ <listitem><simpara>if <literal>True</literal> the call may block
waiting for an event.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara><literal>TRUE</literal> if events were
+ <listitem><simpara><literal>True</literal> if events were
dispatched.</simpara></listitem>
</varlistentry>
</variablelist>
@@ -111,7 +111,7 @@ to be processed;</simpara>
</listitem>
<listitem>
<simpara>then if no events sources are ready and
-<parameter>may_block</parameter> is <literal>TRUE</literal>, waiting for a
+<parameter>may_block</parameter> is <literal>True</literal>, waiting for a
source to become ready;</simpara>
</listitem>
<listitem>
@@ -121,8 +121,8 @@ sources that are ready</simpara>
</itemizedlist>
<para>Note that even when <parameter>may_block</parameter> is
-<literal>TRUE</literal>, it is still possible for
-<methodname>iteration</methodname>() to return <literal>FALSE</literal>,
+<literal>True</literal>, it is still possible for
+<methodname>iteration</methodname>() to return <literal>False</literal>,
since the the wait may be interrupted for other reasons than an event source
becoming ready.</para>
@@ -137,7 +137,7 @@ becoming ready.</para>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara><literal>TRUE</literal> if events are
+ <listitem><simpara><literal>True</literal> if events are
pending.</simpara></listitem>
</varlistentry>
</variablelist>
diff --git a/docs/reference/pyglib-mainloop.xml b/docs/reference/pyglib-mainloop.xml
index bd12fca..913e743 100644
--- a/docs/reference/pyglib-mainloop.xml
+++ b/docs/reference/pyglib-mainloop.xml
@@ -101,10 +101,10 @@ functions.</para>
</varlistentry>
<varlistentry>
<term><parameter>is_running</parameter> :</term>
- <listitem><simpara>if <literal>TRUE</literal> indicates that the
+ <listitem><simpara>if <literal>True</literal> indicates that the
loop is running. This is not very important since calling the <link
linkend="method-glibmainloop--run"><methodname>run</methodname>()</link>
- method will set this to <literal>TRUE</literal>
+ method will set this to <literal>True</literal>
anyway.</simpara></listitem>
</varlistentry>
<varlistentry>
@@ -155,7 +155,7 @@ that the mainloop was created with.</para>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara><literal>TRUE</literal> if the mainloop is
+ <listitem><simpara><literal>True</literal> if the mainloop is
currently being run.</simpara></listitem>
</varlistentry>
</variablelist>
diff --git a/docs/reference/pygobject-functions.xml b/docs/reference/pygobject-functions.xml
index 7ca3918..1f50fbe 100644
--- a/docs/reference/pygobject-functions.xml
+++ b/docs/reference/pygobject-functions.xml
@@ -233,16 +233,16 @@ instance</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara><literal>TRUE</literal> if
+ <listitem><simpara><literal>True</literal> if
<parameter>parent_type</parameter> is an ancestor of
<parameter>type</parameter></simpara></listitem>
</varlistentry>
</variablelist>
<para>The <function>gobject.type_is_a</function>() function returns
-<literal>TRUE</literal> if the specified <parameter>type</parameter> is a
+<literal>True</literal> if the specified <parameter>type</parameter> is a
descendant of the type specified by <parameter>parent_type</parameter>. This
-function also returns <literal>TRUE</literal> if
+function also returns <literal>True</literal> if
<parameter>parent_type</parameter> is an interface and
<parameter>type</parameter> conforms to it.</para>
diff --git a/docs/reference/pygobject.xml b/docs/reference/pygobject.xml
index ac41e47..42cd37b 100644
--- a/docs/reference/pygobject.xml
+++ b/docs/reference/pygobject.xml
@@ -760,13 +760,13 @@ identifier</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara><literal>TRUE</literal> if the signal handler
+ <listitem><simpara><literal>True</literal> if the signal handler
is connected to the object.</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>handler_is_connected</methodname>() method
-returns <literal>TRUE</literal> if the signal handler with the specified
+returns <literal>True</literal> if the signal handler with the specified
<parameter>handler_id</parameter> is connected to the object.</para>
</refsect2>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]