-
Notifications
You must be signed in to change notification settings - Fork 78
docs: Type-safe code generated interface for future calls #390
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
docs: Type-safe code generated interface for future calls #390
Conversation
|
@marcelomendoncasoares here's the PR for the future calls docs |
marcelomendoncasoares
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the quick PR on the docs, @Crazelu! I have left a few guidelines about the experience we aim with docs on the comments, and also some improvement/fixes suggestions.
Beyond these, I missed a reference on the usage of abstract to declare future calls in modules, that users can extend in their own projects - since there is no way for users to mixture the ones generated in the module with their own. We should also present the support for inheritance of future calls in itself.
Another extra page that is worth adding is Recurring tasks to show how to achieve a cron-like scheduling. The current recommended way is by scheduling a future call inside another - at the start, for example. With generated future calls, though, it will probably be a two step operation or require the creation of two separate future calls: one for the unit execution, the other for invoking the first twice (now and next) to make it recurrent.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
|
@marcelomendoncasoares the docs are updated now |
marcelomendoncasoares
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Excellent work on the docs, @Crazelu! Just two small details and we are good to go 🚀
marcelomendoncasoares
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work, @Crazelu!!
Now we just need to merge main and copy the new docs to the versioned_docs/version-3.2.0 path, so it gets updated in the versioned docs.
7073ea1 to
34323f1
Compare
Adds documentation for the type-safe code generated interface for future calls.
Closes: serverpod/serverpod#4607