https://github.com/python/cpython/commit/343182853f19a42c0ba8980d3104076a8c7bcfe7
commit: 343182853f19a42c0ba8980d3104076a8c7bcfe7
branch: main
author: Jean-Louis GUENEGO <[email protected]>
committer: vstinner <[email protected]>
date: 2025-06-06T15:16:12+02:00
summary:

feat(docs): type fix - apply pep8 by using docstring instead of comment in the 
doc. (#135181)

Giving the right example incitates the tutorial readers to do the same in the 
future.

files:
M Doc/tutorial/modules.rst

diff --git a/Doc/tutorial/modules.rst b/Doc/tutorial/modules.rst
index de7aa0e2342946..47bf7547b4ae1d 100644
--- a/Doc/tutorial/modules.rst
+++ b/Doc/tutorial/modules.rst
@@ -27,14 +27,16 @@ called :file:`fibo.py` in the current directory with the 
following contents::
 
    # Fibonacci numbers module
 
-   def fib(n):    # write Fibonacci series up to n
+   def fib(n):
+       """Write Fibonacci series up to n."""
        a, b = 0, 1
        while a < n:
            print(a, end=' ')
            a, b = b, a+b
        print()
 
-   def fib2(n):   # return Fibonacci series up to n
+   def fib2(n):
+       """Return Fibonacci series up to n."""
        result = []
        a, b = 0, 1
        while a < n:

_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]

Reply via email to