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

Should we remove old versionadded docs tags? #2281

Closed
itzpr3d4t0r opened this issue Jul 1, 2023 · 4 comments
Closed

Should we remove old versionadded docs tags? #2281

itzpr3d4t0r opened this issue Jul 1, 2023 · 4 comments
Labels

Comments

@itzpr3d4t0r
Copy link
Member

itzpr3d4t0r commented Jul 1, 2023

In my opinion, considering that the first version of pygame-ce is 2.1.3 and it already encompasses all the functionalities of older versions of pygame, it is both confusing and unnecessary for actual users to be aware of which version each feature was added in. This is particularly true because users who try to search for these versions won't find them anyway. Therefore, in my PRs for the documentation (#2262 #2263), I have removed the .. versionaddedold:: tags. What are your thoughts on this? How should we handle these tags in our docs? should we keep them or remove them?

I would also like to clarify that I am not advocating for the removal of pygame-ce version-specific documentation, as that serves a purpose by highlighting pygame-ce features.

The process of removing these tags will not be swift since a substantial portion of our documentation requires rephrasing and improvement. Hence, I suggest that we gradually phase out these tags while rewriting the documentation.

An example:
image

@bilhox
Copy link
Contributor

bilhox commented Jul 1, 2023

: versionaddedold is used if it's an older version of pygame 2.1.3 ?

@NOTMEE12
Copy link

NOTMEE12 commented Jul 4, 2023

in some community projects it's neccesary to know in which version was feature added so other people could use the compatible version. I think we should keep it.

@ankith26
Copy link
Member

ankith26 commented Jul 6, 2023

I'm in favour of keeping it. I don't think maintaining the distinction leads to confusion

@itzpr3d4t0r
Copy link
Member Author

itzpr3d4t0r commented Jul 6, 2023

Okay, I suppose the general sentiment is to keep them (I still think they serve little to no purpose to a pygame-ce user but whatever) so I'll close this as not planned. I'll reimplement the versionadded tags to my other docs PRs.

@itzpr3d4t0r itzpr3d4t0r closed this as not planned Won't fix, can't repro, duplicate, stale Jul 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants