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

miss-islington · jlguenego · web-flow · commit 705fa8a23fab · 2025-06-06T13:23:07.000Z
feat(docs): type fix - apply pep8 by using docstring instead of comment in the doc. (GH-135181) Giving the right example incitates the tutorial readers to do the same in the future. (cherry picked from commit 3431828) Co-authored-by: Jean-Louis GUENEGO <jlguenego@gmail.com>
diff --git 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:
