Repository navigation
[doc] Error in functional how-to example #84152
Description
| BPO | 39971 |
|---|---|
| Nosy | @rhettinger, @terryjreedy, @ericvsmith, @dxflores, @slateny |
| PRs |
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 = None
created_at = <Date 2020-03-15.16:39:23.863>
labels = ['easy', '3.11', '3.9', '3.10', 'docs']
title = '[doc] Error in functional how-to example'
updated_at = <Date 2022-03-29.07:57:47.314>
user = 'https://github.com/dxflores'bugs.python.org fields:
activity = <Date 2022-03-29.07:57:47.314>
actor = 'eric.smith'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-03-15.16:39:23.863>
creator = 'dxflores'
dependencies = []
files = []
hgrepos = []
issue_num = 39971
keywords = ['patch', 'easy']
message_count = 6.0
messages = ['364247', '364275', '364346', '364708', '364709', '364710']
nosy_count = 6.0
nosy_names = ['rhettinger', 'terry.reedy', 'eric.smith', 'docs@python', 'dxflores', 'slateny']
pr_nums = ['32172']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue39971'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']
Activity
dxflores commentedon Mar 15, 2020
Hello,
A code example from the 'functional programming how-to' raises an error.
The simplest fix would be to remove the Ellipsis object from the 'line_list'.
Thank you,
Diogo
Please check below for the commands issued:
# https://docs.python.org/3/howto/functional.html#generator-expressions-and-list-comprehensions
ericvsmith commentedon Mar 16, 2020
I don't think that was meant to be a literal example. I think that "..." here means "and other strings".
dxflores commentedon Mar 16, 2020
Agreed, Eric. Nevertheless, I think that this example might raise unnecessary confusion to someone new to Python, and hence the reason why I decided to open the issue. Anyhow, I trust your judgement and please feel free to leave things as is and close this issue.
PS: I really the work you did with dataclasses, and I actually explored the idea further with a small (300 LoC) library that adds runtime type checking for instances of dataclasses - if you are ever curious you can find the code on my GitHub at /dxflores/invis.
Thank you,
Diogo
terryjreedy commentedon Mar 20, 2020
In think examples should run and that '...' should be replaced by something like "' \n', ''". The blank string looks ahead to the next example, which adds ' if line != ""' to the comprehension.
[-]Error on documentation - Quick fix.[/-][+]Error in functional how-to example[/+]2 remaining items
terryjreedy commentedon Mar 20, 2020
Looking around further, examples meant to be executable as is are given interactive prompts and needed doctest directives
>>> gen #doctest: +ELLIPSIS <generator object generate_ints at ...>I think that this example should get the same treatment. Non-executable examples are usually clearly non-executable because then contain undefined names line 'expr2' and 'sequence2', whereas this example starts by defining 'line_list'.
[-]Error in functional how-to example[/-][+][doc] Error in functional how-to example[/+][-]Error in functional how-to example[/-][+][doc] Error in functional how-to example[/+]