Skip to content

[0.15.0] - 2025-04-17

Choose a tag to compare

@untergeek untergeek released this 18 Apr 04:00
· 2 commits to main since this release

Added


- Switched to Google-style docstrings to all classes and methods in all modules.
- Included ``Example`` sections for methods with >2 lines, with doctests where feasible.
- Added ``__repr__`` methods to waiter classes (``Relocate``, ``Snapshot``, ``Health``,
  ``Exists``, ``IndexLifecycle``, ``IlmPhase``, ``IlmStep``, ``Restore``, ``Task``) for
  better debugging.
- Updated, replaced or added Sphinx RST files (``index.rst``, ``installation.rst``,
  ``usage.rst``, ``api.rst``) for ReadTheDocs.

Changed
  • Ensured all docstring lines are under 80 characters for linter compliance.
  • Improved documentation clarity with consistent formatting and cross-references.
  • Dependency version bumps:
    • tiered-debug==1.2.1
    • es_client>=8.18.1 for tests only.

Impact


- Enhanced code maintainability with comprehensive, Sphinx-compatible docstrings.
- Improved debugging via ``__repr__`` methods showing key waiter attributes.
- Enabled professional ReadTheDocs documentation with API reference and examples.