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

docs: fix missing code in getting_started #77

Closed
wants to merge 1 commit into from

Conversation

seflue
Copy link

@seflue seflue commented Oct 29, 2024

The code example missed the .send() call and the necessary import.

The code example missed the `.send()` call and the necessary import.
@tqwewe
Copy link
Owner

tqwewe commented Oct 29, 2024

Hi @seflue, thanks for taking the time to make this PR. Actually in the main branch, the code shown in the examples are valid with simply awaiting the .tell() call directly. This is thanks to PR #72 which implements IntoFuture for requests, which is the same behaviour as .send().await, but with less boilerplate.

This will be available in the next release of Kameo :)

@tqwewe tqwewe closed this Oct 29, 2024
@seflue
Copy link
Author

seflue commented Oct 29, 2024

Hi @tqwewe, thanks for the quick reaction. I see, your library is progressing quickly. Is it possible to read the online version of the docs bound to a specific version? I appreciate good documentation and I assume, that it took you quite some effort to write the book. So the motivation for my PR was to not let newcomers run into an issue with the very first example. Is there another way I can help you to keep code and docs aligned?

@tqwewe
Copy link
Owner

tqwewe commented Oct 29, 2024

The docs.rs page will show the docs per version. In terms of the kameo book, sadly there's not a user friendly way to do so. You can however specify a commit/branch/pr by appending ~ to the url of the kameo book. For example https://docs.page/tqwewe/kameo~4a551c31b318623301170941f9f2f27e1e4f9c97

Thank you for your offer to help with documentation, it's definitely something important but also time consuming. I've tried to keep up with all of it, and have recently updated lots of the code docs, so I'm not sure where exactly documentation might be lacking currently. However if you do find anything that can be improved, I'd be happy to review and merge any other PRs

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.

2 participants