Skip to content

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

Conversation

OskarStark
Copy link
Contributor

@OskarStark OskarStark commented Feb 28, 2019

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

@javiereguiluz
Copy link
Member

@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.

@OskarStark
Copy link
Contributor Author

OskarStark commented Feb 28, 2019

@javiereguiluz what do you think of ff0c6c3 ?
Otherwise this info is gone or shall it be removed completely?

cc @xabbuh

@wouterj
Copy link
Member

wouterj commented Feb 28, 2019

Otherwise this info is gone or shall it be removed completely?

I think removing it is fine. It's not really usefull information and IIRC services are private by default in newer symfony versions?

@xabbuh
Copy link
Member

xabbuh commented Feb 28, 2019

I am not convinced that we should really make this in the 3.4 branch. It will mean a lot of maintenance work if we do not only remove them once we start the docs for a new major version.

@OskarStark
Copy link
Contributor Author

@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

@wouterj
Copy link
Member

wouterj commented Feb 28, 2019

In the past, we've used the following guideline (#4774):

  • Remove all versionadded directives - and any other notes related to features changing or being new - for the version (e.g. 2.1) from the master branch. The result is that the next release (which is the first that comes entirely after the end of maintenance of this branch), will have no mentions of the old version (e.g. 2.1).

@OskarStark
Copy link
Contributor Author

OskarStark commented Mar 1, 2019

Ok so closing this PR and removing all obsolete versionadded directives from master which are not: .. versionadded:: 4.3 ?

@javiereguiluz
Copy link
Member

@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?

@OskarStark
Copy link
Contributor Author

OskarStark commented Mar 1, 2019

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 3.3, 3.2, 2.x versionadded-directives in the 3.4 branch) and I should proceed here, right? 🙈 😄

I created a separate PR to get feedback for handling such cases:
#11072

@OskarStark OskarStark force-pushed the remove-obsolete-versionadded-directives branch from ff0c6c3 to ea5aa96 Compare March 1, 2019 12:47
@OskarStark OskarStark force-pushed the remove-obsolete-versionadded-directives branch 3 times, most recently from 3546769 to e19caed Compare March 1, 2019 13:29
@OskarStark OskarStark marked this pull request as ready for review March 1, 2019 13:29
@OskarStark
Copy link
Contributor Author

There are a few more, but they need some rework I guess.

Please review and after merging this I will check 4.2 and master for obsolete versionadded directives 👍

@OskarStark OskarStark force-pushed the remove-obsolete-versionadded-directives branch from e19caed to 91b3058 Compare March 1, 2019 13:32
@OskarStark OskarStark force-pushed the remove-obsolete-versionadded-directives branch from 91b3058 to 667493e Compare March 1, 2019 13:37
@javiereguiluz
Copy link
Member

@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:

  • 3.4 can contain 3.0, 3.1, 3.2, 3.3 and 3.4 directives ... but not 2.x
  • 4.2 can contain 4.0, 4.1, and 4.2 directives ... but not 2.x or 3.x

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 😢

@OskarStark
Copy link
Contributor Author

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 👍

@OskarStark
Copy link
Contributor Author

In this case the following paragraph should be reworded: #11081

@OskarStark OskarStark deleted the remove-obsolete-versionadded-directives branch March 4, 2019 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants