Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves API documentation clarity by updating docstrings and type hints across the codebase. The changes focus on replacing plain text references with Sphinx cross-references (:class:, :func:), improving type annotations, and expanding documentation for better user understanding.
- Enhanced cross-references using Sphinx notation for better documentation navigation
- Added return type annotations to functions in
cost.py - Expanded documentation in
estimate.pywith detailed property descriptions - Updated Sphinx configuration to include
__call__methods in generated documentation
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/stacie/utils.py | Reformatted example text and converted plain text references to Sphinx cross-references |
| src/stacie/spectrum.py | Updated docstring to use Sphinx cross-references and clarified return value usage |
| src/stacie/model.py | Converted NotImplementedError reference to Sphinx cross-reference |
| src/stacie/estimate.py | Significantly expanded documentation with detailed property lists and Sphinx cross-references |
| src/stacie/cutoff.py | Added type hint NDArray[float] to dictionary parameter and updated method reference |
| src/stacie/cost.py | Added return type annotations list[NDArray[float]] to three functions |
| docs/source/conf.py | Added __call__ to special-members in autodoc configuration |
| docs/clean.sh | Added jupyter_execute directory to cleanup script |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
gozdetoraman
left a comment
There was a problem hiding this comment.
@tovrstra looks good to me, just some minor suggestions to docstrings.
Co-authored-by: Gözde Toraman <toramangozdenur@gmail.com>
Co-authored-by: Gözde Toraman <toramangozdenur@gmail.com>
|
@gozdetoraman Thanks for checking. To avoid repetition, I've mentioned elsewhere which are statistical estimates. I'll merge soon but further adjustments remain welcome. |
These are some collected minor clarifications to the API documentation (docstrings and type hints).