-
Notifications
You must be signed in to change notification settings - Fork 26
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
Link to "Latest" in version selector #551
Comments
I think it's a bad practice, because in the future, when this link can be opened, there may be not such method, and receiver will not understand what did you mean. That's also the reason why when you give a link to a code in a repository — it's better to replace But you can get such link on Ruby API, just remove a version: https://rubyapi.org/o/array#method-i-clear |
That's a good point, but having a permanent link solution would be very helpful. If something gets removed it'd be a lot better to show "Removed in Ruby x.y" and link to the last version of the documentation than to 404. This is all to make links as durable and long-lived as possible. It could also help from an "SEO" perspective so the results aren't cluttered up with various versions of exactly the same thing since using meta tags you can steer them all to the generic version. When trying to find documentation normally using a regular search engine I have to be exceedingly specific about the version, like "ruby array compact 2.7.1" or I'll get some unbelievably antiquated results from the main Ruby docs. That |
So, to display such text it should be for any existed at some time method, a page can be over-bloated. And if you want to render such text only for requested method from URL anchor — it can be difficult, but, of course, possible. By the way, URL anchors work in such way that this is just auto-scrolling on a page, there is no 404. Also, another point: what if you're referencing on method There're version locks of dependencies (and Ruby is dependency of your code, your discussion) not "just because", it's important for guaranteed working (including people understanding in discussions). So, it's still bad way (I'm sure) for your examples. The only way where I can use RubyAPI.org links without Ruby version — browser autocomplete, so when (once in year) a new Ruby version released — my links stay unchanged. But it still can be a problem when I use some method or arguments from this latest documentation in non-updated (with previous Ruby version) project, I have to be attentive.
I don't think that mutating links "long live". If you're using product "Foo" (IDE, git-client, browser, something else… Opera, for example!), and then there is "Foo 2" (or "Foo X") — is "Foo" still living? In fact, yes, but this is not that Foo to which you're used to: there can be new things, there can be no other things, etc. So, in software "long-lived" is when some version of some software works even after a time. |
When leaving advice about how to use a particular method somewhere that needs to be long-lived it'd be nice to have a link to the "Latest" version of Ruby as an option. This is not "Master" which could be confusing since it's the upcoming version.
Having a more permanent version of a link to a method or class would help a lot in that case.
Right now URLs are of the form:
A permalink version might be of the form:
For the latest stable version, whatever that happens to be at the time.
The text was updated successfully, but these errors were encountered: