Add order parameter to Context.new_console.

I've also added the common use of order to the getting started examples.

Author: HexDecimal

CHANGELOG.rst

@@ -8,6 +8,8 @@ v2.0.0
 
 Unreleased
 ------------------
+Added
+ - Added the important `order` parameter to `Context.new_console`.
 
 11.18.3 - 2020-12-28
 --------------------

docs/tcod/getting-started.rst

@@ -35,7 +35,7 @@ Example::
             "dejavu10x10_gs_tc.png", 32, 8, tcod.tileset.CHARMAP_TCOD,
         )
         # Create the main console.
-        console = tcod.Console(WIDTH, HEIGHT)
+        console = tcod.Console(WIDTH, HEIGHT, order="F")
         # Create a window based on this console and tileset.
         with tcod.context.new(  # New window for a console of size columns×rows.
             columns=console.width, rows=console.height, tileset=tileset,
@@ -97,7 +97,7 @@ Example::
             width=WIDTH, height=HEIGHT, sdl_window_flags=FLAGS
         ) as context:
             while True:
-                console = context.new_console()
+                console = context.new_console(order="F")
                 console.print(0, 0, "Hello World")
                 context.present(console, integer_scaling=True)
 

tcod/context.py

@@ -49,7 +49,9 @@
 """  # noqa: E501
 import os
 import sys
-from typing import Any, Iterable, List, Optional, Tuple
+from typing import Any, Iterable, List, Optional, Tuple, Union
+
+from typing_extensions import Literal
 
 import tcod
 import tcod.event
@@ -267,6 +269,7 @@ def new_console(
         min_columns: int = 1,
         min_rows: int = 1,
         magnification: float = 1.0,
+        order: Union[Literal["C"], Literal["F"]] = "C",
     ) -> tcod.console.Console:
         """Return a new console sized for this context.
 
@@ -278,6 +281,9 @@ def new_console(
         consoles, which will show as larger tiles when presented.
         `magnification` must be greater than zero.
 
+        `order` is passed to :any:`tcod.console.Console` to determine the
+        memory order of its NumPy attributes.
+
         The times where it is the most useful to call this method are:
 
         * After the context is created, even if the console was given a
@@ -286,6 +292,12 @@ def new_console(
         * After any window resized event, or any manual resizing of the window.
 
         .. versionadded:: 11.18
+
+        .. versionchanged:: 11.19
+            Added `order` parameter.
+
+        .. seealso::
+            :any:`tcod.console.Console`
         """
         if magnification < 0:
             raise ValueError(
@@ -299,7 +311,7 @@ def new_console(
             )
         )
         width, height = max(min_columns, size[0]), max(min_rows, size[1])
-        return tcod.console.Console(width, height)
+        return tcod.console.Console(width, height, order=order)
 
     def recommended_console_size(
         self, min_columns: int = 1, min_rows: int = 1