pybricks.tools: Add category headings.

pybricks · Apr 21, 2023 · be9f99d · be9f99d
1 parent 870aae8
commit be9f99d
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/doc/main/tools/index.rst b/doc/main/tools/index.rst
@@ -1,11 +1,14 @@
 .. pybricks-requirements::
 
-:mod:`tools <pybricks.tools>` -- Timing tools
+:mod:`tools <pybricks.tools>` -- General purpose tools
 ========================================================
 
 .. automodule:: pybricks.tools
     :no-members:
 
+Timing tools
+---------------
+
 .. autofunction:: wait
 
 .. autoclass:: pybricks.tools.StopWatch
@@ -19,6 +22,9 @@
 
     .. automethod:: pybricks.tools.StopWatch.reset
 
+Linear algebra tools
+--------------------
+
 .. pybricks-requirements:: stm32-float
 
 .. autoclass:: pybricks.tools.Matrix

diff --git a/src/pybricks/tools.py b/src/pybricks/tools.py
@@ -1,7 +1,7 @@
 # SPDX-License-Identifier: MIT
-# Copyright (c) 2018-2022 The Pybricks Authors
+# Copyright (c) 2018-2023 The Pybricks Authors
 
-"""Common tools for timing, data logging, and geometry math tools."""
+"""Common tools for timing, data logging, and linear algebra."""
 
 from __future__ import annotations