Skip to content
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

When should we deprecate references to 6.c? #2688

Closed
JJ opened this issue Mar 20, 2019 · 4 comments
Closed

When should we deprecate references to 6.c? #2688

JJ opened this issue Mar 20, 2019 · 4 comments
Labels
meta RFCs, general discussion, writing style, repository organization, etc. versions Version issues: old behavior still described, things that need a explicit version number...

Comments

@JJ
Copy link
Contributor

JJ commented Mar 20, 2019

The problem

Some references to 6.c are still here and there. For the time being we are simply putting them in past tense, but there will come a time when they will be more confusing than helpful.

Suggestions

This goes way back to #302. I don't think that we will really have the resources to version documentation; we can barely keep up with actually documenting current version (see #2632 #2673 ). Let's discuss here what can be done about these deprecations and how to deal with them.

@JJ JJ added the meta RFCs, general discussion, writing style, repository organization, etc. label Mar 20, 2019
@coke
Copy link
Collaborator

coke commented Mar 21, 2019

The ideal state for me is that there is a combined version of the docs that includes the various documented versions, and/or a way to generate a version of the docs that is for a specific version of the language.

Ideally, for the public site, we'd default to latest, and allow a user to switch the desired version of the language they want to see the docs for.

While 6.c is no longer the latest, it's definitely still available in recent rakudo releases; while it's tempting to remove the docs at that point, ideally they would still be available for reference. (Just like old versions of Java docs.)

@JJ
Copy link
Contributor Author

JJ commented Mar 21, 2019 via email

@JJ JJ added the versions Version issues: old behavior still described, things that need a explicit version number... label Mar 25, 2019
@rafaelschipiura
Copy link
Contributor

6.c will be used for a long time. 1 year after release is a really short time.

@coke
Copy link
Collaborator

coke commented Feb 4, 2023

Current planning for dealing with versions is to have a single version of the documentation for all supported versions of the language, and 6.c as noted, is going to be around for a while. If there's a plan in the community to deprecate older versions, we can consider our approach then. Eliminating support for 6.c in the rakudo compiler would be a huge undertaking.

In the meantime, we should be moving towards tags on classes/methods etc. when they are specific to a given version.

@coke coke closed this as completed Feb 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta RFCs, general discussion, writing style, repository organization, etc. versions Version issues: old behavior still described, things that need a explicit version number...
Projects
None yet
Development

No branches or pull requests

3 participants