This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author martin.panter
Recipients akuchling, berker.peksag, docs@python, jstasiak, martin.panter, ncoghlan, pakal, pitrou, terry.reedy
Date 2016-11-14.01:45:50
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1479087951.93.0.504746021883.issue8840@psf.upfronthosting.co.za>
In-reply-to
Content
In general I agree with the doc strings giving the main details, and leaving smaller details for the reference documentation. Maybe for concrete implementations like BytesIO, it is not worth saying the expanded contents are undefined. One other way to make them shorter is to drop “as reported by tell()”.

diff --git a/Lib/_pyio.py b/Lib/_pyio.py
@@ -344,10 +344,12 @@
     def truncate(self, pos=None):
+        """Resize stream to at most size bytes.

Wouldn’t it be more correct to say “at most ‘pos’ bytes”?

You should avoid mentioning byte sizes for TextIOBase.truncate(); see Issue 25849. Also applies to the StringIO subclasses.

+        Position in the stream is left unchanged.  Size defaults to

I think it should be “The position in the stream . . .”, to match the other full sentences in these paragraphs.
History
Date User Action Args
2016-11-14 01:45:52martin.pantersetrecipients: + martin.panter, akuchling, terry.reedy, ncoghlan, pitrou, pakal, docs@python, berker.peksag, jstasiak
2016-11-14 01:45:51martin.pantersetmessageid: <1479087951.93.0.504746021883.issue8840@psf.upfronthosting.co.za>
2016-11-14 01:45:51martin.panterlinkissue8840 messages
2016-11-14 01:45:50martin.pantercreate