From dc4ac696714bf89c07be03991bf16db56a90683b Mon Sep 17 00:00:00 2001 From: hannah Date: Thu, 10 Apr 2025 14:40:37 -0400 Subject: [PATCH] document what basic units is --- galleries/examples/units/basic_units.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/galleries/examples/units/basic_units.py b/galleries/examples/units/basic_units.py index 486918a8eafc..f7bdcc18b0dc 100644 --- a/galleries/examples/units/basic_units.py +++ b/galleries/examples/units/basic_units.py @@ -5,6 +5,14 @@ Basic units =========== + +This file implements a units library that supports registering arbitrary units, +conversions between units, and math with unitized data. This library also implements a +Matplotlib unit converter and registers its units with Matplotlib. This library is used +in the examples to demonstrate Matplotlib's unit support. It is only maintained for the +purposes of building documentation and should never be used outside of the Matplotlib +documentation. + """ import itertools