Skip to content

[FrameworkBundle] remove redundant PHPDoc in console Descriptor #36008

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

noemi-salaun
Copy link
Contributor

Q A
Branch? 3.4
Bug fix? no
New feature? no
Deprecations? no
Tickets None
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:

    /**
     * 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

    /**
     * Describes container parameters.
     */
    abstract protected function describeContainerParameters(ParameterBag $parameters, array $options = []);

    /**
     * Describes container tags.
     */
    abstract protected function describeContainerTags(ContainerBuilder $builder, array $options = []);

kept

    /**
     * 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 = []);

…ubclass

The PHPDoc for some describeXXX methods in the abstract Descriptor was inacurate or redundant.
@nicolas-grekas
Copy link
Member

Thank you @noemi-salaun.

@nicolas-grekas nicolas-grekas merged commit cd08bf4 into symfony:3.4 Mar 12, 2020
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.

3 participants