-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
remove obsolete versionadded directives #11068
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
remove obsolete versionadded directives #11068
Conversation
@OskarStark yes! This is perfect. On each major version we remove manually all versionadded directives that refer to older versions. It makes sense, because if you are reading 3.4 docs, you don't care if something was added in 3.2 or 3.1. Same if you are reading 4.2 docs ... you don't care if some change was made in 3.4 or 4.1. The directives you removed here were the ones we forgot to remove manually. Thanks. |
@javiereguiluz what do you think of ff0c6c3 ? cc @xabbuh |
I think removing it is fine. It's not really usefull information and IIRC services are private by default in newer symfony versions? |
I am not convinced that we should really make this in the |
@xabbuh I am totally fine providing a PR against 4.2 or master, however you guys decide, but this is what I talked about with Javier |
In the past, we've used the following guideline (#4774):
|
Ok so closing this PR and removing all obsolete versionadded directives from master which are not: |
@OskarStark your last comment is not correct :) What @wouterj showed is just a specific example ... the "general rule" is ... when a new version is created, all the previous "versionadded" are removed. That's why 4.2 should only have "versionadded:: 4.2" and not "2.x, 3.x, 4.0, and 4.1" (and "2.3" should have "versionadded:: 2.3" but not "2.0, 2.1, and 2.2"). @xabbuh this is what we've always tried to do. Since this is a manual process (and since we "backdocument" things because we have a huge backlog) sometimes we forget about old "versionadded" directives. Oskar, is it more clear now? |
I think I already understood the problem here, and after your explanation, this PR is totally valid (currently not complete, as there are much more I created a separate PR to get feedback for handling such cases: |
ff0c6c3
to
ea5aa96
Compare
3546769
to
e19caed
Compare
There are a few more, but they need some rework I guess. Please review and after merging this I will check |
e19caed
to
91b3058
Compare
91b3058
to
667493e
Compare
@OskarStark we talked about this in the private Symfony Docs team chat ... it turns out I was completely wrong. We remove "versionadded" directives when we create a MAJOR version, not a MINOR version. Example:
So, we must close this as "won't merge" and instead, try to find 2.x and 3.x directives in 4.2 branch. Oskar, I'm terribly sorry for having made you waste your time with this pull request 😢 |
really no problem, I will try to rework the rule 👍 |
In this case the following paragraph should be reworded: #11081 |
These are older than the current
3.4
version and should be removed.@javiereguiluz is this what you meant?
I will proceed after I got some feedback from you
cc @weaverryan