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

It's better to add more examples to the doc on how to use this crate correctly. #1

Closed
skirodev opened this issue Nov 15, 2022 · 3 comments

Comments

@skirodev
Copy link

Thank you for your awesome work on this crate! On the one hand, undoubtedly, it has many features that a job queue should have. On the other hand, because of this, it can be a bit difficult to learn to use quickly, so I think more examples could be provided in the doc on how to use its features.

@dimfeld
Copy link
Owner

dimfeld commented Nov 15, 2022

Yes, I agree this would be helpful. In the meantime, it may be useful to look at the tests. https://github.com/dimfeld/prefect/blob/0b40516aae42642a5040bee89bdf3708c1282e72/prefect/src/lib.rs#L264. But of course they are also not quite like real use cases.

@dimfeld
Copy link
Owner

dimfeld commented Nov 27, 2022

Added the first example in 8846ae9. More to come

@dimfeld
Copy link
Owner

dimfeld commented Nov 28, 2022

Superceded by #3 where I put a list of examples to write. :)

@dimfeld dimfeld closed this as completed Nov 28, 2022
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