-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[FrameworkBundle] add --deprecations on debug:container command #35995
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
[FrameworkBundle] add --deprecations on debug:container command #35995
Conversation
7d99b07
to
090219a
Compare
Thanks for the taking over! |
Oh ok, I was targeting the same version as the previous PR but I guess 5.0 was release since ^^ |
090219a
to
bb483d1
Compare
Oh I rebased before switching the targeted branch for this PR, so the CI failed |
The history of commits is weird, can you take a look for remove the commit alreay merge |
I have restarted from Simperfit branch, rebase it on top of master and then cherry pick my commit. I think it should be good now :) |
bb483d1
to
ea53d42
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wanted to give it a try also, you beat me at this
Thank you continuing this, i think it will be very usefull
src/Symfony/Bundle/FrameworkBundle/Command/ContainerDebugCommand.php
Outdated
Show resolved
Hide resolved
src/Symfony/Bundle/FrameworkBundle/Command/ContainerDebugCommand.php
Outdated
Show resolved
Hide resolved
ea53d42
to
8215063
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for taking over this
src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great! it's look good to me
src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php
Outdated
Show resolved
Hide resolved
022653f
to
44d85b6
Compare
…criptor (noemi-salaun) This PR was merged into the 3.4 branch. Discussion ---------- [FrameworkBundle] remove redundant PHPDoc in console Descriptor | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | no <!-- please update src/**/CHANGELOG.md files --> | Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files --> | Tickets | None <!-- prefix each issue number with "Fix #", if any --> | License | MIT | Doc PR | N/A The PHPDoc for some `describeXXX` methods in the abstract `Symfony\Bundle\FrameworkBundle\Console\Descriptor\Descriptor` was inaccurate or redundant. I remove the PHPDoc in the superclass and the `{@inheritdoc}` in the child class as suggested by @chalasr in this PR comment #35995 (comment) I keep the PHPDoc when it adds some explanation about the method or its params. For exemple : ### inaccurate: ```php /** * Describes an InputArgument instance. */ abstract protected function describeRouteCollection(RouteCollection $routes, array $options = []); /** * Describes an InputOption instance. */ abstract protected function describeRoute(Route $route, array $options = []); ``` ### redundant ```php /** * Describes container parameters. */ abstract protected function describeContainerParameters(ParameterBag $parameters, array $options = []); /** * Describes container tags. */ abstract protected function describeContainerTags(ContainerBuilder $builder, array $options = []); ``` ### kept ```php /** * Describes event dispatcher listeners. * * Common options are: * * name: name of listened event */ abstract protected function describeEventDispatcherListeners(EventDispatcherInterface $eventDispatcher, array $options = []); /** * Describes a callable. * * @param mixed $callable */ abstract protected function describeCallable($callable, array $options = []); ``` <!-- Replace this notice by a short README for your feature/bugfix. This will help people understand your PR and can be used as a start for the documentation. Additionally (see https://symfony.com/releases): - Always add tests and ensure they pass. - Never break backward compatibility (see https://symfony.com/bc). - Bug fixes must be submitted against the lowest maintained branch where they apply (lowest branches are regularly merged to upper ones so they get the fixes too.) - Features and deprecations must be submitted against branch master. --> Commits ------- e535e7d [FrameworkBundle] remove redundant PHPDoc in console Descriptor and subclass
44d85b6
to
6e2e068
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @noemi-salaun for taking over!
$this->assertStringContainsString('[OK] There are no deprecations in the logs!', $tester->getDisplay()); | ||
} | ||
|
||
public function testGetDeprecationNoFile(): void |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
void
should be removed
6e2e068
to
ee6391e
Compare
Thank you @noemi-salaun. |
And thank you @Simperfit of course also! |
I apologize in advance, I am not fluent in English
Continuity of @Simperfit work from his PR #32584
I added support for XML, JSON and markdown formats as well as unit tests for all formats.
XML format
JSON format
Markdown format
Remaining deprecations (5)
I added a new commit on top of @Simperfit 's one, but I don't know how you would like to have the git history writed.