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

"Generalization" misused in deque docs #68011

Closed
rschwieb mannequin opened this issue Mar 31, 2015 · 2 comments
Closed

"Generalization" misused in deque docs #68011

rschwieb mannequin opened this issue Mar 31, 2015 · 2 comments
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@rschwieb
Copy link
Mannequin

rschwieb mannequin commented Mar 31, 2015

BPO 23823
Nosy @rhettinger

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 = None
closed_at = <Date 2015-03-31.14:52:41.896>
created_at = <Date 2015-03-31.13:56:02.405>
labels = ['type-feature', 'invalid', 'docs']
title = '"Generalization" misused in deque docs'
updated_at = <Date 2015-03-31.14:52:41.851>
user = 'https://bugs.python.org/rschwieb'

bugs.python.org fields:

activity = <Date 2015-03-31.14:52:41.851>
actor = 'rhettinger'
assignee = 'docs@python'
closed = True
closed_date = <Date 2015-03-31.14:52:41.896>
closer = 'rhettinger'
components = ['Documentation']
creation = <Date 2015-03-31.13:56:02.405>
creator = 'rschwieb'
dependencies = []
files = []
hgrepos = []
issue_num = 23823
keywords = []
message_count = 2.0
messages = ['239710', '239720']
nosy_count = 3.0
nosy_names = ['rhettinger', 'docs@python', 'rschwieb']
pr_nums = []
priority = 'normal'
resolution = 'not a bug'
stage = None
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue23823'
versions = ['Python 2.7', 'Python 3.2', 'Python 3.3', 'Python 3.4', 'Python 3.5', 'Python 3.6']

@rschwieb
Copy link
Mannequin Author

rschwieb mannequin commented Mar 31, 2015

This sentence in the deque docs (https://docs.python.org/2/library/collections.html#collections.deque) is not accurate:

"Deques are a generalization of stacks and queues ..."

Deques are a _specialization_ of stacks and queues. Every deque is-a stack and is-a queue, but saying that "deques generalize stacks and queues" reverses this relationship.

On the surface it might seem minor, but I think it's worth correcting in this case since the "is-a" relationship is so fundamental in computer science. Besides, I'd like to think Python's awesome documentation is above using words to mean the opposite of what they mean :)

@rschwieb rschwieb mannequin assigned docspython Mar 31, 2015
@rschwieb rschwieb mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Mar 31, 2015
@rhettinger
Copy link
Contributor

Sorry, I disagree.

@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
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement
Projects
None yet
Development

No branches or pull requests

1 participant