Skip to content
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

add publish method on phpDoc annotation on Redis Facade #54448

Draft
wants to merge 1 commit into
base: 11.x
Choose a base branch
from

Conversation

emrancu
Copy link
Contributor

@emrancu emrancu commented Feb 3, 2025

Added the missing PHPDoc annotation for the publish method in Illuminate\Support\Facades\Redis.

Changes:

  • Added @method static void publish(string $channel, string $message) to Redis Facade.

Benefits:

  • Provides better IDE autocompletion and static analysis support.
  • Enhances developer experience by documenting the publish method explicitly.
  • Does not introduce any breaking changes or modify existing functionality.

This update improves Laravel's developer experience by ensuring better code assistance when using Redis publish/subscribe functionality.

@crynobone
Copy link
Member

We already have a GitHub Actions to update the facades docblock on each commit. Even if this get merged to GitHub Actions should still revert it.

@emrancu
Copy link
Contributor Author

emrancu commented Feb 4, 2025

@crynobone It's not possible to add publish command to Redis docblock automatically. Because it call with magic __call.

@crynobone crynobone requested a review from timacdonald February 4, 2025 06:01
@crynobone crynobone marked this pull request as draft February 4, 2025 15:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants