Added array into documentation

javicarron · Feb 20, 2024 · 19a4e2d · 19a4e2d
1 parent 1248ec1
commit 19a4e2d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/pynkowski/__init__.py b/pynkowski/__init__.py
@@ -51,6 +51,7 @@
 
 - [`data`](https://javicarron.github.io/pynkowski/pynkowski/data.html)
  - [`base_da`](https://javicarron.github.io/pynkowski/pynkowski/data/base_da.html)
+ - [`array`](https://javicarron.github.io/pynkowski/pynkowski/data/array.html)
  - [`healpix`](https://javicarron.github.io/pynkowski/pynkowski/data/healpix.html)
  - [`utils_da`](https://javicarron.github.io/pynkowski/pynkowski/data/utils_da.html)
  

diff --git a/pynkowski/data/__init__.py b/pynkowski/data/__init__.py
@@ -1,6 +1,7 @@
 '''This module contains all the classes to work with data in several conventions. Currently, the implemented formats are the following:
 
-- [`base_da`](data/base_da.html): the abstract class for general data fields, to be used as the base for the other fields.
+- [`base_da`](data/base_da.html): the base class for data fields, to be used as the base for the other fields.
+- [`array`](data/array.html): fields in the form of numpy arrays of arbitrary dimension, typically used for 2D or 3D maps.
 - [`healpix`](data/healpix.html): scalar maps on the sphere in the healpix convention. An optional interface for $P^2$ is included.
 
 - There is also a general utilities submodule called [`utils_da`](data/utils_da.html).