Fix inconsistencies in the documentation compared to the paper#29
Fix inconsistencies in the documentation compared to the paper#29tovrstra wants to merge 5 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the STACIE documentation to align notation and scaling conventions with the referenced paper (notably moving the factor (h) into the definition of (C_k)), adds explicit Fourier transform conventions, and refreshes tooling/configuration for building and maintaining the docs.
Changes:
- Adjust discrete PSD/ACF formulas to include (h) in (C_k) and propagate the change through related derivations and definitions.
- Expand the “Notation” section into “Notation and Conventions” with explicit continuous/discrete Fourier transform definitions.
- Modernize Sphinx
conf.pyversion retrieval and bump pre-commit hook revisions.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/source/theory/statistics.md | Updates PSD/ACF derivations and replaces remaining (\hat{C}_k) uses with (\hat{I}_k) where appropriate. |
| docs/source/theory/overview.md | Aligns high-level theory overview equations with the new (h)-in-(C_k) convention. |
| docs/source/theory/notation.md | Renames/extends notation section and adds explicit Fourier transform definitions. |
| docs/source/conf.py | Switches to setuptools_scm.get_version() for version discovery with newer dependency versions. |
| .pre-commit-config.yaml | Updates hook versions to newer releases. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
@RobbeBohy Could you double check the changes? This is not urgent at all. These mistakes have been around for a while now, so no rush. (Some of these came up during thesis reviews.) |
RobbeBohy
left a comment
RobbeBohy
left a comment
There was a problem hiding this comment.
Looks good to me. I made a few minor suggestions regarding the Special Functions.
| - $\gamma(z, x)$ is the lower incomplete Gamma function. | ||
| - $\Gamma(z)$ is the [Gamma function](https://en.wikipedia.org/wiki/Gamma_function). | ||
| - $\gamma(z, x)$ is the [lower incomplete Gamma function](https://en.wikipedia.org/wiki/Incomplete_gamma_function). | ||
| - $\psi(\alpha)$ is the [digamma function](https://en.wikipedia.org/wiki/Digamma_function). |
There was a problem hiding this comment.
| - $\psi(\alpha)$ is the [digamma function](https://en.wikipedia.org/wiki/Digamma_function). | |
| - $\psi(z)$ is the [digamma function](https://en.wikipedia.org/wiki/Digamma_function). |
Is there a specific reason for using
| \end{aligned} | ||
| $$ | ||
|
|
||
| where $\psi_1(\alpha)$ is the [trigamma](https://en.wikipedia.org/wiki/Trigamma_function) function. |
There was a problem hiding this comment.
This could be added to the Special Functions in notation.md. I will make a suggestion for this.
| - $\Gamma(z)$ is the [Gamma function](https://en.wikipedia.org/wiki/Gamma_function). | ||
| - $\gamma(z, x)$ is the [lower incomplete Gamma function](https://en.wikipedia.org/wiki/Incomplete_gamma_function). | ||
| - $\psi(\alpha)$ is the [digamma function](https://en.wikipedia.org/wiki/Digamma_function). | ||
|
|
There was a problem hiding this comment.
| - $\psi_1(z)$ is the [trigamma function](https://en.wikipedia.org/wiki/Trigamma_function). |
As suggested in a comment below, I would propose to add the trigamma function under the special functions as well.
Fixes #28
Other related corrections:
docs/conf.pyto make it work with the latest version of the documentation dependencies