Rename :stages to something else

dashbitco / broadway

Concurrent and multi-stage data ingestion and data processing with Elixir

https://elixir-broadway.org

Apache License 2.0

2.43k stars 161 forks source link

Rename :stages to something else #147

Closed josevalim closed 4 years ago

josevalim commented 4 years ago

People often consider :stages to be multiple steps. Even the GenStage docs say:

Stages are data-exchange steps that send and/or receive data from other stages.

/cc @adkron - if you have any other concrete suggestions on the docs, please let us know!

whatyouhide commented 4 years ago

:concurrency (as in :max_concurrency in Task.async_stream/*)
:processes

are my suggestions. Great change btw :)

mcrumm commented 4 years ago

:+1: for :concurrency - personally i'd rather not use processes because we have processor(s), too.

adkron commented 4 years ago

@josevalim, thanks for the cc. You are on top of things and I wish I had been on top of making a suggestion here. I was right in the thick of it when we started the recording and never got back to it. Thank you. ❤️

I think that :concurrency is a nice suggestion because it speaks to the purpose. :processes points me to what is going on under the covers and makes me think of OTP level abstractions. So, I'm a little torn. I think that I would go with :concurrency if I had to pick one on the spot.

whatyouhide commented 4 years ago

@josevalim can we deprecate stages? I can do the work if you'd like. It would help us migrate :)

josevalim commented 4 years ago

It has been deprecated in the commit above. :)

whatyouhide commented 4 years ago

@josevalim completely missed that, sorry. I was on my phone 😄 Awesome 🙃