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

Correct batch publishing function name in README.md #16

Merged
merged 1 commit into from
Jul 17, 2024

Conversation

jordanhiltunen
Copy link
Contributor

Cool library!

I was trying to experiment with it locally, using the examples in the README to get started, but I couldn't get batch publishing to work.

It looks like while the README references publish_batch, the actual function for the producer is batch_publish.

fn batch_publish<'a, F>(&'a mut self, n: usize, update: F)

The README references a `publish_batch` function.
I couldn't get that to work; digging through the source, it looks like it intends to refer to the `batch_publish` function:

https://github.com/nicholassm/disruptor-rs/blob/22e13239eddf5f6695238dbde8d6121059dfeb69/src/producer.rs#L218
@nicholassm
Copy link
Owner

Many thanks.
I seriously need to find a nice way to run the code in the readme as part of the tests - this is not the first typo... (Although I caught the others myself. :-) )

@nicholassm nicholassm merged commit fe73a85 into nicholassm:main Jul 17, 2024
2 of 3 checks passed
@jordanhiltunen jordanhiltunen deleted the patch-1 branch July 17, 2024 10:29
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