`LineReceiver` API documentation should indicate when delimiter is stripped etc

[jml]

LineReceiver.lineReceived is called with a line sans delimiter. LineReceiver.sendLine will add the delimiter to whatever is passed to it. These facts should be included in the API documentation for LineReceiver.

[exarkun]

(In [29607]) Branching to 'linereceiver-docs-4542'

[exarkun]

Please review

[jesstess]

Thanks for working on this, exarkun. Some review feedback:

• copyright bump
• the two sendLines need @type markup for the 'line' parameter.
• "return self.transport.writeSequence((line,self.delimiter))" ===> "return self.transport.writeSequence((line, self.delimiter))"
• IntNStringReceiver.stringReceived has the 'msg' parameter but adds epytext markup for 'string' (the rest of the stringReceived methods in the file pass 'string'). [ this doesn't cause a pydoctor error :-( ]

side note:

• SafeNetstringReceiver is deprecated in the docstring but not with any code support

Other than that, this looks good to merge.

[exarkun]

(In [29783]) Branching to 'linereceiver-docs-4542-2'

[exarkun]

Some wicked conflicts with the netstring branch that just landed. I merged forward and resolved them, ended up changing a few more things than were mentioned in the review, so another check would be nice.

Everything mentioned should be fixed now. There's #4546 for SafeNetstringReceiver.

Thanks for the review!

[TimAllen]

Looks good to merge.

[exarkun]

 Build results

[exarkun]

(In [29883]) Merge linereceiver-docs-4542-2

Author: exarkun Reviewer: jesstess, screwtape Fixes: #4542

Make the single parameter to the sendString methods of classes in twisted.protocols.basic consistently named and document it. Do the same for the parameter to the stringReceived and lineReceived methods as well.