Skip to content

Commit a4abebc

Browse files
kam193sebp
authored andcommitted
Clarify signal's arguments declaration
Expected type is any sequence. Example presents one-element tuple and this is only reason why it has comma at the end. Remove suggest that list need to end with comma Comma is used only to tell python it's a one-element tuple, not just brackets. Fixes #177
1 parent d4f83d8 commit a4abebc

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

source/objects.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ The second part, ``None``, indicates the return type of the signal,
8282
usually ``None``.
8383

8484
``(int,)`` indicates the signal arguments, here, the signal will only
85-
take one argument, whose type is int. This argument type list must end with a
86-
comma.
85+
take one argument, whose type is int. Types of arguments required by
86+
signal are declared as a sequence, here it is a one-element tuple.
8787

8888
Signals can be emitted using :meth:`GObject.GObject.emit`:
8989

@@ -336,8 +336,8 @@ API
336336

337337
:const:`GObject.SIGNAL_RUN_FIRST` can be replaced with
338338
:const:`GObject.SIGNAL_RUN_LAST` or :const:`GObject.SIGNAL_RUN_CLEANUP`.
339-
``None`` is the return type of the signal. ``(int,)`` is the list of the
340-
parameters of the signal, it must end with a comma.
339+
``None`` is the return type of the signal. ``(int,)`` is the tuple of the
340+
parameters of the signal.
341341

342342
.. attribute:: __gproperties__
343343

0 commit comments

Comments
 (0)