Skip to content

Commit a483813

Browse files
committed
fix doc build warnings
1 parent 1119596 commit a483813

File tree

4 files changed

+6
-41
lines changed

4 files changed

+6
-41
lines changed

docs/modules.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ Data Accessors
1313

1414
.. automodapi:: tollan.accessor
1515

16-
.. automodapi:: tollan.accessor.mappers
16+
.. automodapi:: tollan.accessor.netcdf4
17+
18+
.. automodapi:: tollan.accessor.pandas
19+
20+
.. automodapi:: tollan.accessor.xarray
1721

1822
Configuration System
1923
--------------------

src/tollan/accessor/accessor.py

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,6 @@ class AccessorBase[DataSourceT, MapperT: Mapper]:
3030
Type of data source (e.g., xr.Dataset, pandas.DataFrame)
3131
MapperT : Mapper
3232
Type of mapper used for field resolution
33-
34-
Attributes
35-
----------
36-
mapper : MapperT
37-
Field mapper for data access
38-
data_source : DataSourceT
39-
Data source containing the data
4033
"""
4134

4235
_mapper_cls: ClassVar[type[MapperT]] # pyright: ignore[reportGeneralTypeIssues]

src/tollan/accessor/xarray/accessor.py

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,6 @@ class XarrayAccessorBase[MapperT: Mapper](AccessorBase[DataSourceT, MapperT]):
6666
---------------
6767
MapperT : Mapper
6868
Type of mapper for field resolution
69-
70-
Attributes
71-
----------
72-
_data_source : Dataset, DataArray, or DataTree
73-
Original data source
74-
mapper : MapperT
75-
Field mapper for data access
76-
data_source : Dataset
77-
Resolved Dataset (DataTree → root, DataArray → wrapped)
7869
"""
7970

8071
def __init__(

src/tollan/accessor/xarray/units.py

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -64,30 +64,7 @@ class UnitsAccessor:
6464
6565
Provides properties and methods for setting, getting, and converting physical
6666
units using Astropy's units framework. Units are stored in .attrs["units"]
67-
as strings. Registered as the 'u' accessor on DataArrays.
68-
69-
Attributes
70-
----------
71-
_obj : xr.DataArray
72-
The DataArray this accessor is attached to
73-
74-
Properties
75-
----------
76-
unit_str : str or None
77-
The unit string from .attrs["units"], or None if not set
78-
unit : astropy.units.Unit or None
79-
The Astropy Unit object, or None if not set
80-
quantity : astropy.units.Quantity
81-
The data as an Astropy Quantity object (converts to numpy array)
82-
83-
Methods
84-
-------
85-
set(unit)
86-
Set units (only if not already set or same unit)
87-
unset()
88-
Remove units
89-
to(target_unit, equivalencies=None)
90-
Convert to different units (lazy evaluation preserved)
67+
as strings. Registered as the 'u' accessor on DataArrays
9168
9269
Examples
9370
--------

0 commit comments

Comments
 (0)