Skip to content

Should we remove old versionadded docs tags? #2281

Closed as not planned
Closed as not planned
@itzpr3d4t0r

Description

@itzpr3d4t0r

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions