Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

BUG: refguide-check incorrectly flags references to equations in docstrings #20608

Open
DietBru opened this issue Apr 29, 2024 · 2 comments · May be fixed by #20610
Open

BUG: refguide-check incorrectly flags references to equations in docstrings #20608

DietBru opened this issue Apr 29, 2024 · 2 comments · May be fixed by #20610
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org

Comments

@DietBru
Copy link
Contributor

DietBru commented Apr 29, 2024

python dev.py refguide-check complains when referencing equations from within a docstring with :math:numref:`EQ_LABEL` though the hyperlink gets generated correctly. The error message is:

 (ERROR/3) Unknown interpreted text role "math:numref".::

Using such references from within .rst-files is not a problem (consult, e.g., signal.rst).
@github-actions github-actions bot added the defect A clear bug or issue that prevents SciPy from being installed or used as expected label Apr 29, 2024
@DietBru DietBru added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org and removed defect A clear bug or issue that prevents SciPy from being installed or used as expected labels Apr 29, 2024
@ev-br
Copy link
Member

ev-br commented Apr 29, 2024

https://github.com/scipy/scipy/blob/main/tools/refguide_check.py#L339 has a whitelist of "ok unknown items", this one should probably be added.

@DietBru
Copy link
Contributor Author

DietBru commented Apr 29, 2024

Thanks @ev-br, I'll fix it in my upcoming PR where I will be using :math:numref:`EQ_LABEL` .

@DietBru DietBru linked a pull request Apr 29, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

ENH: signal.ShortTimeFFT: determine arbitrary dual windows DietBru/scipy
2 participants
@ev-br @DietBru