-
-
Notifications
You must be signed in to change notification settings - Fork 25.9k
DOC Fix broken ref #30407
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.
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
DOC Fix broken ref #30407
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I checked the rendered docs and they look good. Setting auto-merge
Whoops bad merge I think! Thanks @jeremiedbb ! |
Like @jeremiedbb, I would have expected it to be caught by the CI, I guess adding Whether it is a good idea to turn this warning into an error is left as an exercise:
The warnings looks like this:
|
Looking at scikit-learn/build_tools/circle/build_doc.sh Lines 242 to 253 in 6c30015
So maybe we didn't pick up the error in #30316 because that file did not change (I accepted the merge change from main). I think this is really an edge case but a potential fix could be to regularly (weekly?) run doc build on main and check for warnings (filtering some out). (i.e. a weekly CI job, not related to PRs) Note I did build the docs locally a little while ago and noticed some reference (?) warnings, which was on my to-do list to fix a little while ago but I never got round to it 😅 For proof, in #30319 I did a bad merge and there was an undefined label, which did cause CI failure: (Note that if you search for 'warning' in the output, there are many other warnings ) This was fixed in commit d25d36b , where you can see CIs passed (i.e. the other warnings did not cause the CI failure, it was just the undefined label). |
Indeed, warnings should be turned into errors in scikit-learn/build_tools/circle/build_doc.sh Lines 277 to 281 in 6c30015
Ah yeah good point, the issue happened in an unchanged file and Not entirely sure whether it's worth doing something about it to be honest ... |
Agreed, happy to leave it |
Follow-up of #30316
Seen in the 1.6 release PR (see). I don't know why it wasn't caught by the CI in the original PR...