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

Improve PHPDoc annotations for ResponseFactory class #723

Open
wants to merge 1 commit into
base: 2.x
Choose a base branch
from

Conversation

mohammadrasoulasghari
Copy link

Improve PHPDoc annotations for ResponseFactory class📝

This pull request improves the PHPDoc annotations for the ResponseFactory class in the Inertia package. The updates include comprehensive documentation for all methods, proper type hints, parameter descriptions, and return value information.📝

Changes

  • Added missing PHPDoc blocks for previously undocumented methods
  • Enhanced existing documentation with more detailed parameter and return type descriptions
  • Added proper type hints in PHPDoc comments

Benefits

  • Improved developer experience with better code completion in IDEs
  • Clearer understanding of method purposes and parameters
  • Better static analysis support

Files Changed

  • src/ResponseFactory.php

No functional changes were made - this PR only improves code documentation.

@mohammadrasoulasghari mohammadrasoulasghari force-pushed the docs/improve-response-factory-phpdoc branch from 86a7b4e to c46fef2 Compare March 13, 2025 01:25
@mohammadrasoulasghari mohammadrasoulasghari marked this pull request as draft March 13, 2025 01:26
@mohammadrasoulasghari
Copy link
Author

I only changed the document and there was no change in the logic, so why are the tests being fielded?

@mohammadrasoulasghari mohammadrasoulasghari marked this pull request as ready for review March 13, 2025 01:28
- Added missing PHPDoc blocks for all methods
- Improved existing documentation with better parameter and return
- Added proper type hints in PHPDoc comments
@mohammadrasoulasghari mohammadrasoulasghari force-pushed the docs/improve-response-factory-phpdoc branch from c46fef2 to ae5398b Compare March 13, 2025 01:29
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.

1 participant