Bug-fix release

This release closes the following issues.

• Fix wrong auto-generated docstrings #22
  • In v0.6.1, auto-generated docstrings of DataArray classes are wrong.
    This issue will fix it by updating the xarray_custom.bases.Doc class.
• Fix wrong docstring of utils module #23
  • In v0.6.1, code examples in the docstring of the utils module are outdated.
    This issue will update them so that they are compatible with the latest package.
• Release v0.6.2 #24
  • Update version numbers (0.6.1 → 0.6.2) written in:
    • xarray_custom/__init__.py
    • tests/test_package.py
    • docs/conf.py
    • pyproject.toml

Bug-fix release

This release closes the following issues.

• Fix dims in DataArrayClassBase #18
  • In the v0.6.0 release, dims = "ch" is wrongly treated like dims = ("c", "h") in the codes.
    This issue adds some codes to ensure that dims = "ch" is converted to dims = ("ch",).
• Release v0.6.1 #20
  • Update version numbers (0.6.0 → 0.6.1) written in:
    • xarray_custom/__init__.py
    • tests/test_package.py
    • docs/conf.py
    • pyproject.toml

Update release

This release closes the following issues:

• Use real inheritance #13
  • Add DataArrayClassBase class for the base class of custom DataArray classes
  • Add accessor class variable to the definition of a DataArray class
• Release v0.6.0 #16
  • Update version numbers written in:
    • xarray_custom/__init__.py
    • tests/test_package.py
    • docs/conf.py
    • pyproject.toml
  • Update GitHub Actions workflows

Docs-update release

• Add xarray's license to the project (because the documentation uses its icon)
• Add installation, requirements, and license sections to README

Update release

• Add a feature of an option in the case of overriding an existing accessor (#12)
• Rename an argument of dataarrayclass (override → override_accessor)

Bug-fix release

• Fix ensuring function of dims so that a multiple-letter dim (e.g., 'ch') can properly be set

Update release

• Add utils module to provide include class decorator

Examples

If a definition is written in dataarray.toml:

# dataarray.toml

dims = [ "x", "y" ]
dtype = "float"
desc = "DataArray class to represent images."

[coords.x]
dims = "x"
dtype = "int"
default = 0

[coords.y]
dims = "y"
dtype = "int"
default = 0

then the following two class definitions are equivalent:

@dataarrayclass(accessor='img')
@include('dataarray.toml')
class Image:
    pass

@dataarrayclass(accessor='img')
class Image:
    """DataArray class to represent images."""

    dims = 'x', 'y'
    dtype = float
    x: ctype('x', int) = 0
    y: ctype('y', int) = 0

Update release

• Rename function (coordtype → ctype)
• Usage of dataarrayclass is changed (see documentation)
• dims and dtype of DataArray are now specified as a class attributes
• Add feature of format docstrings of special methods according to class attributes.

Documentation update release

• Fix wrong description of dtype in docstrings
• Add module docstrings

Update release

• Add dataarrayclass decorator to update DataArray classes
• Add coordtype function for class variable annotations
• Add sphinx documentation