docs: add docs for vector.zip (#390)

* docs: add docs for vector.zip

* Update docs/api/backends/vector.backends.awkward_constructors.rst

README.md

@@ -54,6 +54,7 @@ The easiest way to create one or many vectors is with a helper function:
 - `vector.obj` to make a pure Python vector object,
 - `vector.arr` to make a NumPy array of vectors (or `array`, lowercase, like `np.array`),
 - `vector.awk` to make an Awkward Array of vectors (or `Array`, uppercase, like `ak.Array`).
+- `vector.zip` to make an Awkward Array of vectors (similar to `ak.zip`)
 
 ### Pure Python vectors
 

docs/api/backends/vector.backends.awkward_constructors.rst

@@ -0,0 +1,8 @@
+vector.backends.awkward_constructors module
+===========================================
+
+.. automodule:: vector.backends.awkward_constructors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:

docs/api/backends/vector.backends.rst

@@ -16,6 +16,7 @@ Submodules
    vector.backends.object
    vector.backends.numpy
    vector.backends.awkward
+   vector.backends.awkward_constructors
    vector.backends._numba
    vector.backends.numba_numpy
    vector.backends._numba_object

docs/usage/intro.ipynb

@@ -49,8 +49,9 @@
     "The easiest way to create one or many vectors is with a helper function:\n",
     "\n",
     "   * `vector.obj` to make a pure Python vector object,\n",
-    "   * `vector.array` to make a NumPy array of vectors (lowercase, like `np.array`),\n",
-    "   * `vector.Array` to make an Awkward Array of vectors (uppercase, like `ak.Array`)."
+    "   * `vector.arr` to make a NumPy array of vectors (lowercase, like `np.array`),\n",
+    "   * `vector.awk` to make an Awkward Array of vectors (uppercase, like `ak.Array`).\n",
+    "   * `vector.zip` to make an Awkward Array of vectors (similar to `ak.zip`)"
    ]
   },
   {

src/vector/backends/awkward.py

@@ -9,6 +9,8 @@
 .. code-block:: python
 
     vector.Array(...)
+    vector.awk(...)
+    vector.zip(...)
 
 function will have these behaviors built in (and will pass them to any derived
 arrays).