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

Discussion: Should "Revision" be removed from docs? #89

Open
XeduR opened this issue Apr 19, 2021 · 3 comments
Open

Discussion: Should "Revision" be removed from docs? #89

XeduR opened this issue Apr 19, 2021 · 3 comments

Comments

@XeduR
Copy link
Contributor

XeduR commented Apr 19, 2021

Currently most, if not all documentation pages, have a reference to Revision, which should refer to the last version of Solar2D where a particular API was updated/revised.

The reality, however, is that Revision doesn't mean anything. For instance,

  • timer framework was last updated in 2021.3642
  • system.getInfo() was apparently updated in 2021.3639
  • scrollView widget was updated in 2021.3636
  • There have also been several ad plugin updates across the recent version

But all pages state that the last revision was in Release 2020.3619.

Shouldn't we remove reference to Revision in the docs since it does actually do what it is supposed to, but instead it points to a very old build, which will result in numerous issues if someone were to actually download it. It provides no information or value, just a risk for new users.

@Shchvova
Copy link
Contributor

Absolutely

@sekodev
Copy link
Contributor

sekodev commented Apr 24, 2021

Removing those references one-by-one would not be a good idea but maybe we could do something with REVISION_LABEL. Still, not sure if there are any references to that variable elsewhere.

@XeduR
Copy link
Contributor Author

XeduR commented Jul 2, 2021

I'll be doing this removal via automation by next week. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants