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

Type declarations and DocBlocks #16

Open
satyago opened this issue Mar 11, 2021 · 1 comment
Open

Type declarations and DocBlocks #16

satyago opened this issue Mar 11, 2021 · 1 comment

Comments

@satyago
Copy link

satyago commented Mar 11, 2021

Summary

Some of the classes / models do not contain type declarations.
Specifically model scopes and relationships are currently lacking argument and return types.
IMHO adding them would help to avoid breaking compatibility between updates and user land extensions.

Is there any reason the exposed methods (and otherwise) are currently open?
Is this a planned change?

Proposal

Maintain common DocBlocks, argument and return type hints on Laravel models as well as other classes.

Additional Notes

https://github.com/asantibanez/laravel-eloquent-state-machines/blob/master/src/Models/StateHistory.php
https://github.com/asantibanez/laravel-eloquent-state-machines/blob/master/src/Models/PendingTransition.php
[...]

@asantibanez
Copy link
Owner

Hi @satyago

Thanks for your interest in the package.

The API is stable at the moment. No plans on changing the behavior unless it is a major version bump.

Would you mind doing a PR with the referred doc blocs?

Thanks

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

No branches or pull requests

2 participants