Message 124997 - Python tracker

Message124997

Author	sandro.tosi
Recipients	dabrahams, docs@python, pitrou, sandro.tosi
Date	2011-01-01.11:33:44
SpamBayes Score	0.020634862
Marked as misclassified	No
Message-id	<1293881628.22.0.198995502027.issue8626@psf.upfronthosting.co.za>
In-reply-to

Content
That's interesting: do we have a place where we explain how to read the doc? I mean, a place were we can provide example/explain how we write docs, so f.e.: str.rsplit([sep[, maxsplit]]) is a description for a method that could accept 2 optional arguments, none of them keyargs or str.encode(encoding="utf-8", errors="strict") is a description for a method that could take 2 optional args, and they are also keyargs (yeah, I know it's kinda bad-worded, but just to give the idea). If you think it's overkill, let's just close this bug (after all, we have all the doc written our way ;)). Cheers, Sandro

Content

That's interesting: do we have a place where we explain how to read the doc? I mean, a place were we can provide example/explain how we write docs, so f.e.:

  str.rsplit([sep[, maxsplit]])  

is a description for a method that could accept 2 optional arguments, none of them keyargs or

  str.encode(encoding="utf-8", errors="strict")

is a description for a method that could take 2 optional args, and they are also keyargs (yeah, I know it's kinda bad-worded, but just to give the idea).

If you think it's overkill, let's just close this bug (after all, we have all the doc written our way ;)).

Cheers,
Sandro

History
Date	User	Action	Args
2011-01-01 11:33:48	sandro.tosi	set	recipients: + sandro.tosi, pitrou, docs@python, dabrahams
2011-01-01 11:33:48	sandro.tosi	set	messageid: <1293881628.22.0.198995502027.issue8626@psf.upfronthosting.co.za>
2011-01-01 11:33:44	sandro.tosi	link	issue8626 messages
2011-01-01 11:33:44	sandro.tosi	create