pybricks.tools: Document cross product.

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

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/doc/main/tools/index.rst b/doc/main/tools/index.rst
@@ -31,3 +31,5 @@
 .. pybricks-requirements:: stm32-float
 
 .. autofunction:: pybricks.tools.vector
+
+.. autofunction:: pybricks.tools.cross
diff --git a/jedi/tests/test_complete_import.py b/jedi/tests/test_complete_import.py
@@ -155,6 +155,7 @@ def test_from_pybricks_tools_import():
     code = "from pybricks.tools import "
     completions: list[CompletionItem] = json.loads(complete(code, 1, len(code) + 1))
     assert [c["insertText"] for c in completions] == [
+        "cross",
         "DataLog",
         "Matrix",
         "StopWatch",

diff --git a/src/pybricks/tools.py b/src/pybricks/tools.py
@@ -207,6 +207,21 @@ def vector(*args):
     """
 
 
+def cross(a: Matrix, b: Matrix) -> Matrix:
+    """
+    cross(a, b) -> Matrix
+
+    Gets the cross product ``a`` × ``b`` of two vectors.
+
+    Arguments:
+        a (Matrix): A three-dimensional vector.
+        b (Matrix): A three-dimensional vector.
+
+    Returns:
+        The cross product, also a three-dimensional vector.
+    """
+
+
 # HACK: hide from jedi
 if TYPE_CHECKING:
     del Number