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

Update on_success docstring #358

Closed
jnafzig opened this issue Apr 5, 2024 · 0 comments · Fixed by #369
Closed

Update on_success docstring #358

jnafzig opened this issue Apr 5, 2024 · 0 comments · Fixed by #369

Comments

@jnafzig
Copy link

jnafzig commented Apr 5, 2024

Describe the bug

The on_success method is being passed the actual successful events:

self.on_success(success_events)

However, the docs here

Gets passed the number of events flushed.
say that this function will be passed the "number of events flushed"

The docs here are similarly incorrect:
https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/python-tracker/emitters/#on_success

To Reproduce
The example in the online docs under on_failure reproduce the problem: https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/python-tracker/emitters/#on_failure

Expected behavior
The docs should match the behavior.

@Jack-Keene Jack-Keene changed the title Behavior of emitter method on_sucess doesn't match docs Update on_success docstring Aug 23, 2024
Jack-Keene added a commit that referenced this issue Aug 23, 2024
Jack-Keene added a commit that referenced this issue Aug 23, 2024
PR #366 
* Update `on_success` docstring
@greg-el greg-el mentioned this issue Aug 27, 2024
greg-el pushed a commit that referenced this issue Aug 27, 2024
PR #366 
* Update `on_success` docstring
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 a pull request may close this issue.

1 participant