DOC: Fix stretch parameter typo in docstrings - #19871
Conversation
An unmatched single quote in `log'` caused docstring parser to fall back and auto-link `'power'` to the global `power` unit. Closes astropy#19868
|
Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.
|
|
While you did catch a missing quote, alas your patch does not fix the original reported problem. Please see the rendered doc from your PR: https://astropy--19871.org.readthedocs.build/en/19871/api/astropy.visualization.mpl_normalize.simple_norm.html#astropy.visualization.mpl_normalize.simple_norm |
| # TODO! not need to ignore. | ||
| "flag", | ||
| "bits", | ||
| "power", |
There was a problem hiding this comment.
Hmm alas, my hunch was wrong. Your PR doc preview shows that this does not fix the ref. :(
You might have to look at https://github.com/astropy/sphinx-astropy/blob/66e6ba9b13c0869b2259a0726eaedf264def3553/sphinx_astropy/conf/v2.py#L135 or something over there...
|
@arsenelupin14 @pllim - I think astropy/sphinx-astropy#103 might be the proper fix for this (though we should still also do 980ea73 independently of this). |
[ci skip]
pllim
left a comment
There was a problem hiding this comment.
Let's just get the missing quotes in for now. Thanks!
|
I'll squash merge when I see RTD green. |
…9887) Co-authored-by: Ikbar Faiz <ikbarfaiz8@gmail.com> [ci skip]
…871-on-v8.0.x Backport PR #19871 on branch v8.0.x (DOC: Fix stretch parameter typo in docstrings) [ci skip]
Fixes a typo in the stretch parameter description in
mpl_normalize.pyandfits2bitmap.pywherelog'was written instead of'log'. This unmatched quote confused the Sphinx parser, causing it to auto-link'power'to thepowerunit.Prompted by #19868