Skip to content

Commit d8fe699

Browse files
committed
Update the docs too.
1 parent 8a20749 commit d8fe699

File tree

4 files changed

+8
-7
lines changed

4 files changed

+8
-7
lines changed

doc/_static/listings/tutorial3-netstring-reversal.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ class SplitNetstringReceiver(object):
5151
def __init__(self, sender):
5252
self.sender = sender
5353

54-
def prepareParsing(self):
54+
def prepareParsing(self, parser):
5555
pass
5656

5757
def finishParsing(self, reason):

doc/_static/listings/tutorial3-netstrings.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ class NetstringReceiver(object):
2929
def __init__(self, sender):
3030
self.sender = sender
3131

32-
def prepareParsing(self):
32+
def prepareParsing(self, parser):
3333
pass
3434

3535
def finishParsing(self, reason):

doc/_static/listings/tutorial3-netstrings2.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ class NetstringReceiver(object):
3030
def __init__(self, sender):
3131
self.sender = sender
3232

33-
def prepareParsing(self):
33+
def prepareParsing(self, parser):
3434
pass
3535

3636
def finishParsing(self, reason):

doc/tutorial3.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,11 @@ example:
7171

7272
The receiver factory is another one-argument callable which is passed the
7373
constructed sender. The returned object must at least have ``prepareParsing``
74-
and ``finishParsing`` methods. ``prepareParsing`` is called when a connection
75-
is established (i.e. in the ``connectionMade`` of the ``ParserProtocol``) and
76-
``finishParsing`` is called when a connection is closed (i.e. in the
77-
``connectionLost`` of the ``ParserProtocol``).
74+
and ``finishParsing`` methods. ``prepareParsing`` is called with the
75+
``ParserProtocol`` instance when a connection is established (i.e. in the
76+
``connectionMade`` of the ``ParserProtocol``) and ``finishParsing`` is called
77+
when a connection is closed (i.e. in the ``connectionLost`` of the
78+
``ParserProtocol``).
7879

7980
.. note::
8081
Both the receiver factory and its returned object's ``prepareParsing`` are

0 commit comments

Comments
 (0)