search

dashbitco / broadway

Concurrent and multi-stage data ingestion and data processing with Elixir
https://elixir-broadway.org
Apache License 2.0
2.4k stars 158 forks source link

Update documentation about the topology init event #304

Closed rewritten closed 2 years ago

rewritten commented 2 years ago

There is a bit of misleading documentation in the telemetry section, where the [:broadway, :topology, :init] event is said to receive %{supervision: pid, config: keyword} as metadata.

A test at https://github.com/dashbitco/broadway/blob/v1.0.3/test/broadway_test.exs#L254 in fact asserts that the correct key is :supervisor_pid.

Here is the fix to the documentation.

josevalim commented 2 years ago

:green_heart: :blue_heart: :purple_heart: :yellow_heart: :heart: