-
Notifications
You must be signed in to change notification settings - Fork 9
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
Make tau-2pi.svg
dark-mode-friendly
#56
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #56 +/- ##
===========================================
+ Coverage 95.23% 100.00% +4.76%
===========================================
Files 1 1
Lines 21 13 -8
===========================================
- Hits 20 13 -7
+ Misses 1 0 -1 ☔ View full report in Codecov by Sentry. |
@@ -1,6 +1,6 @@ | |||
# Tau.jl | |||
|
|||
<div align="center"><img src="https://rawgit.com/JuliaMath/Tau.jl/master/tau-2pi.svg" width="300"/></div><br/><br/> | |||
<div align="center"><img src="tau-2pi.svg" width="300"/></div><br/><br/> |
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.
I was going to ask whether the URL change would allow the image to continue working outside GitHub, e.g. on https://juliapackages.com/p/tau or https://juliahub.com/ui/Packages/General/Tau, but it turns out the current one already doesn't work, so we might even end up fixing that; and even if we don't, things won't get worse than they already are, so this looks like a strict improvement. Thanks!
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.
I didn't realize the change could have the side effects you mentioned. I've noticed that packages like Pluto.jl
and Flux.jl
use URLs pointing to raw.githubusercontent.com for their images. Given this, it seems prudent to revert this particular change. The correct URL should be: https://raw.githubusercontent.com/JuliaMath/Tau.jl/master/tau-2pi.svg. If you agree, I can submit a pull request to address this.
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.
I'm not sure reverting the change would fix the issue — the image was already broken with the previous URL. Do note, however, that it was a rawgit.com
URL rather than a raw.githubusercontent.com
one, so perhaps a change to the latter would indeed be beneficial. A PR to do that would be very welcome, but perhaps we should make a release first, to check if the simpler filename-only path works. WDYT, @giordano — would a patch release be OK for this?
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.
Yeah, it's probably fine.
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.
Would you mind making the release? 😅 I'm a bit rusty on the process as it's been a while. (Or just point me towards the relevant docs. Do we create a tag for a commit in this repo and TagBot handles the PR to the registry, or is it the other way around?)
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.
- Bump
Line 3 in e951380
version = "2.0.0" - in the page of the commit on the
master
branch which contains the bump, comment with@JuliaRegistrator register
- sit back and relax
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.
@rwnobrega it seems like the simple file path works! Both the README and https://juliahub.com/ui/Packages/General/Tau show the image. (https://juliapackages.com/p/tau still shows the broken image, but its cache hasn't been updated yet, because in the page source code I can see the the attribute data-canonical-src="https://rawgit.com/JuliaMath/Tau.jl/master/tau-2pi.svg"
in the <img>
element, i.e. pointing to the URL prior to this PR and to the release of v2.0.1.) So I'd say we're good and there's no need for further changes! Thanks again for the contribution :)
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.
Great to hear that! Thank you as well. 😄
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.
Good catch and nicely fixed — thank you!
Before this patch:
After: