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

Documentation and Code Organization Improvements #23

Closed
wants to merge 1 commit into from
Closed

Documentation and Code Organization Improvements #23

wants to merge 1 commit into from

Conversation

tal7aouy
Copy link

This pull request aims to enhance the documentation and code organization of the Strictus class to improve clarity, maintainability, and developer experience. The changes introduce comprehensive PHPDoc comments, stricter typing, and better method grouping to facilitate understanding and usage of the class.

Changes Made

  • Added detailed PHPDoc comments to each method, providing clear descriptions, parameter types, and return types.
  • Reorganized the methods to follow a consistent pattern, placing the primary method before its nullable counterpart.
  • Introduced type declarations (mixed, bool, string, array) for method parameters to enhance type safety.
  • Enhanced code readability through proper spacing and indentation.

Please review the proposed modifications, and I am open to any feedback, adjustments, or further suggestions to refine the Strictus class. Thank you for your time and consideration!

@hungthai1401
Copy link
Member

@tal7aouy Thanks. I don't think this change should be added. We have README for the documentation.

@WendellAdriel
Copy link
Member

@tal7aouy thanks for the contribution but these doc blocks are not needed since the types are already declared in the functions signatures, the parameters are not hard to understand their meaning and we have the documentation in README

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.

None yet

3 participants