-
-
Notifications
You must be signed in to change notification settings - Fork 652
Remove spurious diffs in doc previews #40595
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
base: develop
Are you sure you want to change the base?
Conversation
Documentation preview for this PR (built with commit ad9c046; changes) is ready! 🎉 |
does this fix #40530 (comment) also? |
I find filtering out all the Also I don't understand what's the issue with release info, looking at some of the recent PR the "changes is ready!" button doesn't show any of these. |
Perhaps not. I don't know what they are.
…On Sat, Aug 16, 2025, 12:08 PM user202729 ***@***.***> wrote:
*user202729* left a comment (sagemath/sage#40595)
<#40595 (comment)>
I find filtering out all the 0x123456789ABCDEF possibly dangerous. It may
be a better idea to use something like #38945
<#38945> where the 0x123456789 does
not show up in the documentation at all.
Also I don't understand what's the issue with release info, looking at
some of the recent PR the "changes is ready!" button doesn't show any of
these.
—
Reply to this email directly, view it on GitHub
<#40595 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AALDPZOUXCBPXRHUSX4PALL3N2ODTAVCNFSM6AAAAACEARKMB6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTCOJTGI4TQMRYG4>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
The regex filters those only ending with ">".
Perhaps they don't cause diffs. But anyway they are redundant and look bad since the release info is just below the sage logo. They are duplicates. In pdf docs, correct release info appears anyway. |
more likely possibility is that it's caused by #40379 instead (the documentation for pull request is based on e.g. 10.7.beta2, but the old doc that it's diffed against is based on 10.7.beta1). Either that or when the doc build for a certain pull request somehow finish before the doc build CI for the new release finish. But if that information is redundant, is fine either way. |
I see. Thanks.
For example, see https://doc-pr-40610--sagemath.netlify.app/html/hu/a_tour_of_sage/ (the left side). |
needs more work?
Compare the doc preview of this PR with that of #40644: |
anyway, doesn't matter. no, what I mean is we talked about the 0x123456789 showing up in the doc earlier #38945 , and you say that it's a better idea to just let the default argument be ![]() |
Ah, I see. Yes, it is better not to introduce 0x123456789 in the first place. However, we (you and I) cannot prevent that some authors introduce them from time to time. Hence this measure. I hope that the measure is more beneficial than dangerous. Thanks for the review! |
Hm… maybe a better measure is to make the CI fail loudly when such thing is introduced, rather than someone only notice it in the next release and have to "CI fix" it. That can be left for later. |
Again some spurious diffs crawled in. We remove them. For example,
https://doc-pr-40586--sagemath.netlify.app/changes
A sage doc needs to avoid release info in title. I suspect that release info in title is a source of spurious diffs. (I think I saw them in a doc preview changes somewhere, but I cannot find where now...) Anyway the release info is redundant.
Two unused
conf.py
are deleted.📝 Checklist
⌛ Dependencies