classification
Title: platform.linux_distribution() improperly documented
Type: behavior Stage:
Components: Documentation Versions: Python 2.7
process
Status: closed Resolution:
Dependencies: Superseder:
Assigned To: lemburg Nosy List: aronacher, lemburg
Priority: normal Keywords: easy

Created on 2009-02-16 21:41 by aronacher, last changed 2009-02-17 12:50 by lemburg. This issue is now closed.

Messages (3)
msg82273 - (view) Author: Armin Ronacher (aronacher) * (Python committer) Date: 2009-02-16 21:41
platform.linux_distribution() was added in 2.6 as an alias for
platform.dist().  However the documentation lists platform.dist() as an
alias for platform.linux_distribution() and there is no information that
the latter appered in 2.6 whereas the former exists since 2.4 I think.

Not sure what the fix is, but it should be documented properly with "..
versionadded:: 2.6".
msg82306 - (view) Author: Marc-Andre Lemburg (lemburg) * (Python committer) Date: 2009-02-17 09:26
On 2009-02-16 22:42, Armin Ronacher wrote:
> New submission from Armin Ronacher <armin.ronacher@active-4.com>:
> 
> platform.linux_distribution() was added in 2.6 as an alias for
> platform.dist().  However the documentation lists platform.dist() as an
> alias for platform.linux_distribution() and there is no information that
> the latter appered in 2.6 whereas the former exists since 2.4 I think.

> Not sure what the fix is, but it should be documented properly with "..
> versionadded:: 2.6".

Note that dist() redirects to linux_distribution(), not the other
way around.

I'll add the versionadded tags and also clarify the dist() documentation:
it's missing a comment that full_distribution_name is set to false
when redirecting to linux_distribution().
msg82334 - (view) Author: Marc-Andre Lemburg (lemburg) * (Python committer) Date: 2009-02-17 12:50
Fixed in r69717.
History
Date User Action Args
2009-02-17 12:50:21lemburgsetstatus: open -> closed
2009-02-17 12:50:12lemburgsetmessages: + msg82334
versions: - Python 2.6, Python 2.5, Python 2.4, Python 3.0, Python 3.1
2009-02-17 09:26:24lemburgsetmessages: + msg82306
2009-02-16 21:41:12aronachercreate