Add a note

scikit-hep · Jan 30, 2024 · 1aaa2d1 · 1aaa2d1
1 parent 86ca566
commit 1aaa2d1
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -293,6 +293,8 @@ ak.Array(
 
 All of the keyword arguments and rules that apply to `vector.obj` construction apply to `vector.awk` field names.
 
+Finally, the `VectorAwkward` mixins can be subclassed to create custom vector classes. The awkward behavior classes and projections must be named as `*Array`. For example, `coffea` uses the following names - `TwoVectorArray`, `ThreeVectorArray`, `PolarTwoVectorArray`, `SphericalThreeVectorArray`, ...
+
 ## Vector properties
 
 Any geometrical coordinate can be computed from vectors in any coordinate system; they'll be provided or computed as needed.

diff --git a/docs/usage/intro.ipynb b/docs/usage/intro.ipynb
@@ -1060,7 +1060,9 @@
    "id": "beginning-expert",
    "metadata": {},
    "source": [
-    "All of the keyword arguments and rules that apply to `vector.obj` construction apply to `vector.Array` field names."
+    "All of the keyword arguments and rules that apply to `vector.obj` construction apply to `vector.Array` field names.\n",
+    "\n",
+    "Finally, the `VectorAwkward` mixins can be subclassed to create custom vector classes. The awkward behavior classes and projections must be named as `*Array`. For example, `coffea` uses the following names - `TwoVectorArray`, `ThreeVectorArray`, `PolarTwoVectorArray`, `SphericalThreeVectorArray`, ..."
    ]
   },
   {