Skip to content

Commit be9f99d

Browse files
committed
pybricks.tools: Add category headings.
1 parent 870aae8 commit be9f99d

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

doc/main/tools/index.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
.. pybricks-requirements::
22

3-
:mod:`tools <pybricks.tools>` -- Timing tools
3+
:mod:`tools <pybricks.tools>` -- General purpose tools
44
========================================================
55

66
.. automodule:: pybricks.tools
77
:no-members:
88

9+
Timing tools
10+
---------------
11+
912
.. autofunction:: wait
1013

1114
.. autoclass:: pybricks.tools.StopWatch
@@ -19,6 +22,9 @@
1922

2023
.. automethod:: pybricks.tools.StopWatch.reset
2124

25+
Linear algebra tools
26+
--------------------
27+
2228
.. pybricks-requirements:: stm32-float
2329

2430
.. autoclass:: pybricks.tools.Matrix

src/pybricks/tools.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# SPDX-License-Identifier: MIT
2-
# Copyright (c) 2018-2022 The Pybricks Authors
2+
# Copyright (c) 2018-2023 The Pybricks Authors
33

4-
"""Common tools for timing, data logging, and geometry math tools."""
4+
"""Common tools for timing, data logging, and linear algebra."""
55

66
from __future__ import annotations
77

0 commit comments

Comments
 (0)