Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[HttpKernel] Improve PHPDoc on #[AsController] attribute #52147

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

Merged
merged 1 commit into from
Oct 27, 2023

Conversation

muchafm
Copy link
Contributor

@muchafm muchafm commented Oct 18, 2023

Q A
Branch? 6.4
Bug fix? no
New feature? no
Deprecations? no
Tickets Fix #51920
License MIT

Improve PHPDoc on AsController attribute

@carsonbot carsonbot added this to the 6.4 milestone Oct 18, 2023
@carsonbot
Copy link

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (see https://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
  • Features and deprecations must be submitted against the 6.4 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

@@ -12,7 +12,11 @@
namespace Symfony\Component\HttpKernel\Attribute;

/**
* Service tag to autoconfigure controllers.
* To autoconfigure your controllers as serivces you can use
Copy link
Member

@javiereguiluz javiereguiluz Oct 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @muchafm. I like the improvement ... but I'd reword it and expand it a bit. For example:

 * Autoconfigures controllers as services by applying the `controller.service_arguments`
 * tag to them. This allows to inject services in controller action methods, not
 * only in their constructors.
 *
 * @see https://symfony.com/doc/current/controller/service.html

Copy link
Contributor Author

@muchafm muchafm Oct 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I see, thank you for the suggestion, I will apply it

@OskarStark OskarStark changed the title Improve PHPDoc on AsController attribute Improve PHPDoc on #[AsController] attribute Oct 24, 2023
@carsonbot carsonbot changed the title Improve PHPDoc on #[AsController] attribute [HttpKernel] Improve PHPDoc on #[AsController] attribute Oct 24, 2023
@muchafm muchafm requested a review from javiereguiluz October 25, 2023 20:02
@nicolas-grekas
Copy link
Member

Thank you @muchafm.

@nicolas-grekas nicolas-grekas merged commit 3df3372 into symfony:6.4 Oct 27, 2023
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.

Improve PHPDoc descriptions of Attribute classes and parameters
7 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.