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

phpdoc for integration methods #394

Open
staabm opened this issue May 13, 2020 · 2 comments
Open

phpdoc for integration methods #394

staabm opened this issue May 13, 2020 · 2 comments

Comments

@staabm
Copy link

staabm commented May 13, 2020

would be great to have phpdocs for the most used methods which are required for integration with the host applications, e.g.

  • resolveAsCommand
  • resolveAsQueueJob

at best we could have psalm or phpstan like phpdocs, which are pretty precise about the contents of the arrays involved see e.g.

@itsgoingd
Copy link
Owner

yeah, i can see how writing the integration might be challenging since the clockwork internals are not very well documented

not sure i want to commit to phpdoc tho, i like to keep the comments simple, might add api docs to the website instead

@staabm
Copy link
Author

staabm commented May 23, 2020

not sure i want to commit to phpdoc tho, i like to keep the comments simple, might add api docs to the website instead

having only the types defined in the php sources (without further full-text description) would already be enough, as our static analysis jobs (and IDE) would do the rest

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