symfony/symfony-docs

[Config][DependencyInjection] Deprecate the fluent PHP format for seman…

Closed this issue · 3 comments

Q A
Feature PR symfony/symfony#62092
PR author(s) @nicolas-grekas
Merged in 7.4

We created this issue to not forget to document this new feature. We would really appreciate if you can help us with this task. If you are not sure how to do it, please ask us and we will help you.

To fix this issue, please create a PR against the 7.4 branch in the symfony-docs repository.

Thank you! 😃

I already submitted #21511 on the topic for branch 8.0.

On branch 7.4, I think we should do something.
@wouterj objected removing the examples of the deprecated formats (fluent & xml) from the doc.
We still need to tell that those are about a deprecated format.
What about adding a line of text saying so before every example?
This would be done by using .. code-block:: xml-deprecated / .. code-block:: php-deprecated, with some RST extension that'd add that line telling about the deprecation? (and inviting to look at branch 8.0 for the new supported PHP format?)
Any better idea?
(and anyone up to give this a try? I'm not much into RST infra...)

I had this PR prepared for the XML deprecation to better guide people starting new applications to not use XML on 7.4: #21516

I don't personally think we need a deprecated warning in each example. 7.4 is a weird version as it's released with 8.0. This means all /current URLs will link to 8.0. The 7.4 docs will not receive many visitors. Besides that, I feel like people won't open the XML tab unless they already use it. I fear the double deprecation label will only distract people.
However, the fluent PHP deprecation causes some issues as that'll give us 2 PHP tabs for each config snippet. So maybe we have to add the deprecated thing...
TL;DR: Not sure yet, let's see what other documentors think about it.

In any case, this is not hard to add to the rst parser. So we have time to find the best solution.

Closed by #62092.