From 43210253c318b3e9a158deeaa6db1cbe560c6845 Mon Sep 17 00:00:00 2001
From: Tamas Gal <himself@tamasgal.com>
Date: Wed, 3 Jul 2024 13:59:21 +0200
Subject: [PATCH] Add docs for Compass

---
 docs/src/api.md                | 1 +
 docs/src/manual/calibration.md | 7 +++++++
 2 files changed, 8 insertions(+)

diff --git a/docs/src/api.md b/docs/src/api.md
index ee6070d9..deb8ec5f 100644
--- a/docs/src/api.md
+++ b/docs/src/api.md
@@ -94,6 +94,7 @@ calibrate
 calibratetime
 combine
 Orientations
+Compass
 floordist
 slew
 slerp
diff --git a/docs/src/manual/calibration.md b/docs/src/manual/calibration.md
index 0dd13974..4323e386 100644
--- a/docs/src/manual/calibration.md
+++ b/docs/src/manual/calibration.md
@@ -37,3 +37,10 @@ module_id = 817589211
 
 q = o(module_id,  1693408347)
 ```
+
+The quaternions can be converted to [`Compass`](@ref) object which has the
+fields `.yaw`, `.pitch` and `.roll`:
+
+```@example 1
+compass = Compass(q)
+```
-- 
GitLab