ledatelescope / bifrost

A stream processing framework for high-throughput applications.
BSD 3-Clause "New" or "Revised" License
66 stars 29 forks source link

bfmap.rst out of date #99

Closed ewanbarr closed 7 years ago

ewanbarr commented 7 years ago

On master the bfmap.rst docs are out of date as it looks like the map interface has changed.

For example, if I follow the docs:

In [24]: bf.map("c = a + b", c=c, a=a, b=b)
---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
<ipython-input-24-107ca22ae66a> in <module>()
----> 1 bf.map("c = a + b", c=c, a=a, b=b)

TypeError: map() got an unexpected keyword argument 'c'
MilesCranmer commented 7 years ago

Thanks for pointing this out @ewanbarr. The change was posted in #95 (but the docs weren't updated). I'll update the docs straight away.

MilesCranmer commented 7 years ago

It should be fixed now: http://ledatelescope.github.io/bifrost/bfmap.html. Let me know if you notice anything else not up-to-date.

Thanks again, Miles