8000 gh-107017: Rework the Fibonacci example by TommyUnreal · Pull Request #107132 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-107017: Rework the Fibonacci example #107132

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.

Sign up for GitHub

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

Closed
wants to merge 17 commits into from
Closed

gh-107017: Rework the Fibonacci example #107132

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
2383c73
Draft. Rework ´the Fibonacci example.
TommyUnreal Jul 23, 2023
f1cd228
Proofread, fixed the PEP 8, doctest.
TommyUnreal Jul 23, 2023
4f8e940
Fix rst formatting and missing literal block
TommyUnreal Jul 23, 2023
2584707
Fix inline literal.
TommyUnreal Jul 23, 2023
1fae12b
Better multichar end arg example in print().
TommyUnreal Jul 23, 2023
e87530d
Fix review hints. Explain condition better.
TommyUnreal Jul 29, 2023
10107c1
Fix inline literals.
TommyUnreal Jul 29, 2023
cdafb1f
Update Doc/tutorial/introduction.rst
TommyUnreal Jul 29, 2023
3c9bec8
Update Doc/tutorial/introduction.rst
TommyUnreal Jul 29, 2023
6ad0175
Update Doc/tutorial/introduction.rst
TommyUnreal Jul 29, 2023
7722165
Fix multiple assignment example.
TommyUnreal Jul 29, 2023
3c0171e
Corrected grammar errors.
TommyUnreal Jul 29, 2023
fbb36a0
Better wording in example comment.
TommyUnreal Jul 29, 2023
d9a707d
Fixed typo, improved wording.
TommyUnreal Aug 22, 2023
7e627a4
Fixed missing-space-before-role lint error.
TommyUnreal Aug 22, 2023
33a3b3c
fIXED WARNING: Title underline too short lint.
TommyUnreal Aug 22, 2023
0f51c49
Merge branch 'main' into 107017_tutorial_introduction_assumtions_remo…
hugovk Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Better multichar end arg example in print().
  • Loading branch information
@TommyUnreal
TommyUnreal committed Jul 23, 2023
commit 1fae12b644f9e328a50a3a51042cf6c773406f88
8 changes: 4 additions & 4 deletions Doc/tutorial/introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,14 +582,14 @@ Fibonacci series
----------------

Great! Now that we have the knowledge, let's write code to print all numbers
from the Fibonacci series that are lower than 1000.
from the Fibonacci series that are lower than 150.

>>> a, b = 0, 1
>>> while a < 1000:
... print(a, end=', ')
>>> while a < 150:
... print('', a, '', end='->')
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand that this utilities the print sep param, however this is nor explained nor inferred, so to a beginner it may be confusing

Perhaps it could be beneficial to show off f-strings like

Suggested change
... print('', a, '', end='->')
... print(f'{a} ->', end='')

Or to keep end as ->

Suggested change
8000
... print('', a, '', end='->')
... print(f'{a} ', end="->")

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I very strongly prefer the original print('', a, '', end='->'), which reduces the punctuation the learner has to deal with to a minimum, and emphasises instead the connection between more easily assimilated things, like the English word "end" and the "arrow" ("->").

Showing off f-strings while demonstrating a different functionality introduces unnecessary cognitive burden. Two different kinds of quotes and two different kinds of brackets requires a lot of parsing and stopping. I don't think this is the right solution here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My reasoning: As this is an Introduction chapter, I wanted to keep the number of introduced concepts to the minimum. There are ways to code this better, but it is not formally wrong. The default separator is already shown in the example above and this just builds on that, so it's hopefully not confusing to the reader.

... a, b = b, a+b
...
0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377, 610, 987,
0 -> 1 -> 1 -> 2 -> 3 -> 5 -> 8 -> 13 -> 21 -> 34 -> 55 -> 89 -> 144 ->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And I like the way that the example illustrates the value of using end - no need to explain, the example does it much more effectively. This will stick in someone's mind.


.. rubric:: Footnotes

Expand Down
0