Skip to content

Commit 835ca64

Browse files
committed
Docs: add newline between module docstrings and future imports
1 parent 61ce951 commit 835ca64

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/tutorial/part-02.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ It is important to document all variables placed in this module with docstrings.
4848
.. code-block:: python
4949
5050
"""This module stores globally mutable variables used by this program."""
51+
5152
from __future__ import annotations
5253
5354
import tcod.context
@@ -80,6 +81,7 @@ The ``game/tags.py`` module should look like this:
8081
.. code-block:: python
8182
8283
"""Collection of common tags."""
84+
8385
from __future__ import annotations
8486
8587
from typing import Final
@@ -184,6 +186,7 @@ The ``game/components.py`` module should look like this:
184186
.. code-block:: python
185187
186188
"""Collection of common components."""
189+
187190
from __future__ import annotations
188191
189192
from typing import Final, Self
@@ -275,6 +278,7 @@ Make sure :python:`return` has the correct indentation and is not part of the fo
275278
.. code-block:: python
276279
277280
"""Functions for working with worlds."""
281+
278282
from __future__ import annotations
279283
280284
from random import Random
@@ -465,6 +469,7 @@ It should be at the same level as the ``for`` loop and not inside of it.
465469
.. code-block:: python
466470
467471
"""A collection of game states."""
472+
468473
from __future__ import annotations
469474
470475
from typing import Final
@@ -561,6 +566,7 @@ Add :python:`g.world = game.world_tools.new_world()` before the main loop.
561566
562567
#!/usr/bin/env python3
563568
"""Main entry-point module. This script is used to start the program."""
569+
564570
from __future__ import annotations
565571
566572
import tcod.console

docs/tutorial/part-03.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ These methods refer to types from ``tcod`` and those types will need to be impor
2929
.. code-block:: python
3030
3131
"""Base classes for states."""
32+
3233
from __future__ import annotations
3334
3435
from typing import Protocol
@@ -80,6 +81,7 @@ Any states ``on_event`` method could potentially change the state so ``g.states`
8081
.. code-block:: python
8182
8283
"""State handling functions."""
84+
8385
from __future__ import annotations
8486
8587
import tcod.console

0 commit comments

Comments
 (0)