[docs] rename ambiguous `number` argument to `multiplier`

elixir-lang / gen_stage

Producer and consumer actors with back-pressure for Elixir

http://hexdocs.pm/gen_stage

1.52k stars 192 forks source link

[docs] rename ambiguous `number` argument to `multiplier` #243

Closed GavinJoyce closed 5 years ago

GavinJoyce commented 5 years ago

When reading the docs for the first time, I was a little confused by the reuse of number as the argument name for A and B and how they might be related. After running the code, it became clear that they are not related.

I think renaming number to multiplier in B will help others understand this better

josevalim commented 5 years ago

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