diff --git a/README.md b/README.md index a7d5caa..68bbfb5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -
+@@ -14,8 +14,6 @@
- - # piso - pandas interval set operations **piso** exists to bring set operations (union, intersection, difference + more) to [pandas'](https://pandas.pydata.org/) interval classes, specifically @@ -47,7 +45,6 @@ A small [case study](https://piso.readthedocs.io/en/latest/user_guide/calendar.h Visit [https://piso.readthedocs.io](https://piso.readthedocs.io/) for the documentation. - ## Installation `piso` can be installed from PyPI or Anaconda. @@ -64,7 +61,6 @@ To install the latest version through conda-forge:: conda install -c conda-forge piso` ``` - ## Versioning [SemVer](http://semver.org/) is used by piso for versioning releases. For versions available, see the [tags on this repository](https://github.com/staircase-dev/piso/tags). @@ -74,7 +70,6 @@ conda install -c conda-forge piso` This project is licensed under the [MIT License](https://github.com/staircase-dev/piso/blob/master/LICENSE) - ## Acknowledgments Currently, piso is a pure-python implentation which relies heavily on [staircase](https://www.staircase.dev) and [pandas](https://pandas.pydata.org/). It is clearly designed to operate as part of the *pandas ecosystem*. The colours for the piso logo have been assimilated from pandas as a homage, and is not to intended to imply and affiliation with, or endorsement by, pandas. diff --git a/docs/conf.py b/docs/conf.py index 4aba195..933ffcf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -121,7 +121,7 @@ html_theme = "pydata_sphinx_theme" html_theme_options = { - # "google_analytics_id": "UA-27880019-2", + "google_analytics_id": "UA-65430466-3", "github_url": "https://github.com/staircase-dev/piso", } diff --git a/piso/_decorators.py b/piso/_decorators.py index 18df394..71ad907 100644 --- a/piso/_decorators.py +++ b/piso/_decorators.py @@ -6,7 +6,6 @@ class Appender: - """ A function decorator that will append an addendum to the docstring of the target function. diff --git a/piso/accessor.py b/piso/accessor.py index 729b5e5..cb03bf6 100644 --- a/piso/accessor.py +++ b/piso/accessor.py @@ -65,6 +65,14 @@ def decorator(accessor): class ArrayAccessor: + """ + The piso accessor for :class:`pandas.arrays.IntervalArray` and :class:`pandas.IntervalIndex` + + Parameters + ---------- + _interval_array : :class:`pandas.arrays.IntervalArray` or :class:`pandas.IntervalIndex` + """ + def __init__(self, _interval_array): self._interval_array = _interval_array