Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

platform.linux_distribution() improperly documented #49534

Closed
mitsuhiko opened this issue Feb 16, 2009 · 3 comments
Closed

platform.linux_distribution() improperly documented #49534

mitsuhiko opened this issue Feb 16, 2009 · 3 comments
Assignees
@malemburg
Labels
docs Documentation in the Doc dir easy type-bug An unexpected behavior, bug, or error

Comments

@mitsuhiko
Copy link
Member

BPO 5284
Nosy @malemburg, @mitsuhiko

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = 'https://github.com/malemburg'
closed_at = <Date 2009-02-17.12:50:21.156>
created_at = <Date 2009-02-16.21:41:12.913>
labels = ['easy', 'type-bug', 'docs']
title = 'platform.linux_distribution() improperly documented'
updated_at = <Date 2009-02-17.12:50:21.156>
user = 'https://github.com/mitsuhiko'

bugs.python.org fields:

activity = <Date 2009-02-17.12:50:21.156>
actor = 'lemburg'
assignee = 'lemburg'
closed = True
closed_date = <Date 2009-02-17.12:50:21.156>
closer = 'lemburg'
components = ['Documentation']
creation = <Date 2009-02-16.21:41:12.913>
creator = 'aronacher'
dependencies = []
files = []
hgrepos = []
issue_num = 5284
keywords = ['easy']
message_count = 3.0
messages = ['82273', '82306', '82334']
nosy_count = 2.0
nosy_names = ['lemburg', 'aronacher']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue5284'
versions = ['Python 2.7']
@mitsuhiko
Copy link
Member Author

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".

@mitsuhiko mitsuhiko added docs Documentation in the Doc dir easy type-bug An unexpected behavior, bug, or error labels Feb 16, 2009
@malemburg
Copy link
Member

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().

@malemburg
Copy link
Member

Fixed in r69717.

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@malemburg malemburg

Labels
docs Documentation in the Doc dir easy type-bug An unexpected behavior, bug, or error
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mitsuhiko @malemburg