Éric Araujo <merwok(a)netwok.org> added the comment:
The description for the function directive is at http://docs.python.org/dev/documenting/markup.html However, I’m not sure whether the doc is accurate, since there was a switch from spam([style]) to spam(style=None) some time ago, for example in r73291.
Let’s continue the discussion on the other bug.
----------
nosy: +eric.araujo
resolution: -> duplicate
stage: -> committed/rejected
status: open -> closed
superseder: -> Document lack of support for keyword arguments in C functions
_______________________________________
Python tracker <report(a)bugs.python.org>
<http://bugs.python.org/issue8626>
_______________________________________
Sandro Tosi <sandro.tosi(a)gmail.com> added the comment:
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
----------
nosy: +sandro.tosi
_______________________________________
Python tracker <report(a)bugs.python.org>
<http://bugs.python.org/issue8626>
_______________________________________
New submission from Nick Coghlan <ncoghlan(a)gmail.com>:
Brett updated the docs for the test package to (correctly) point out that it is our internal testing package and isn't subject to the same stringent backwards compatibility rules as the rest of the standard library.
A "see also" link pointing readers that have landed there over to the unittest module for their testing infrastructure needs would be a friendly thing to include.
----------
assignee: docs@python
components: Documentation
keywords: easy
messages: 111450
nosy: docs@python, ncoghlan
priority: normal
severity: normal
stage: needs patch
status: open
title: Add reader redirect from test package docs to unittest module
versions: Python 2.7, Python 3.2
_______________________________________
Python tracker <report(a)bugs.python.org>
<http://bugs.python.org/issue9370>
_______________________________________
