Merge pull request #358 from casangi/review_schema_changes

Review schema changes
casangi · Feb 5, 2025 · 67e495d · 67e495d
2 parents 7400703 + 7730d24
commit 67e495d
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 2 deletions.
diff --git a/docs/source/measurement_set/schema_and_api/measurement_set_schema.rst b/docs/source/measurement_set/schema_and_api/measurement_set_schema.rst
@@ -34,6 +34,10 @@ field_and_source_xds
 
    .. xradio_dataset_schema_table:: xradio.measurement_set.schema.FieldSourceXds
 
+.. autoclass:: xradio.measurement_set.schema.FieldSourceEphemerisXds()
+
+   .. xradio_dataset_schema_table:: xradio.measurement_set.schema.FieldSourceEphemerisXds
+
 antenna_xds
 ~~~~~~~~~~~
 .. autoclass:: xradio.measurement_set.schema.AntennaXds()

diff --git a/src/xradio/measurement_set/_utils/_msv2/descr.py b/src/xradio/measurement_set/_utils/_msv2/descr.py
@@ -160,6 +160,6 @@ def populate_ms_descr(
     elif mode == "flat":
         summary += [(ddi, (sdf["rows"], sdf["chans"], sdf["pols"]))]
     else:
-        summary += [((ddi, sdf["times"], sdf["baselines"], sdf["chans"], sdf["pols"]))]
+        summary += [(ddi, sdf["times"], sdf["baselines"], sdf["chans"], sdf["pols"])]
 
     return sdf
diff --git a/src/xradio/measurement_set/schema.py b/src/xradio/measurement_set/schema.py
@@ -629,7 +629,7 @@ class EllipsoidPosLocationArray:
 
 @xarray_dataarray_schema
 class BaselineArray:
-    """Model of the baseline_id coordinate in the main dataset (interferometric data, :py:class:`VisibiiltyXds`)"""
+    """Model of the baseline_id coordinate in the main dataset (interferometric data, :py:class:`VisibilityXds`)"""
 
     data: Data[BaselineId, Union[numpy.int64, numpy.int32]]
     """Unique id for each baseline."""
@@ -1223,6 +1223,8 @@ class SpectrumArray:
     polarization: Coordof[PolarizationArray]
 
     field_and_source_xds: Attr[Union[FieldSourceXds, FieldSourceEphemerisXds]]
+    """ Field and source information. Also alows for variant where ephemeris information is included. """
+
     long_name: Optional[Attr[str]] = "Spectrum values"
     """ Long-form name to use for axis. Should be ``"Spectrum values"``"""
     units: Attr[list[str]] = ("Jy",)
@@ -1243,6 +1245,8 @@ class VisibilityArray:
     frequency: Coordof[FrequencyArray]
 
     field_and_source_xds: Attr[Union[FieldSourceXds, FieldSourceEphemerisXds]]
+    """ Field and source information. Also alows for variant where ephemeris information is included. """
+
     long_name: Optional[Attr[str]] = "Visibility values"
     """ Long-form name to use for axis. Should be ``"Visibility values"``"""
     units: Attr[list[str]] = ("Jy",)

diff --git a/src/xradio/sphinx/schema_table.py b/src/xradio/sphinx/schema_table.py
@@ -212,6 +212,18 @@ def format_attr_model_text(state, attr) -> StringList:
                 state.nested_parse(vl, 0, line)
             return line
 
+        if typing.get_origin(attr.typ) == typing.Union:
+            vl = StringList()
+            type_args = typing.get_args(attr.typ)
+            options = []
+            for i, arg in enumerate(type_args):
+                vl.append(f":py:class:`~{arg.__module__}.{arg.__name__}`", "")
+                if i + 1 < len(type_args):
+                    vl.append(" or ", "")
+            with switch_source_input(state, vl):
+                state.nested_parse(vl, 0, line)
+            return line
+
         # Derived type, e.g. list of types?
         if typing.get_origin(attr.typ) == list and all(
             [isinstance(arg, type) for arg in type_args]