bar first argument is not incr but text

rsalmei / alive-progress

A new kind of Progress Bar, with real-time throughput, ETA, and very cool animations!

MIT License

5.53k stars 206 forks source link

bar first argument is not incr but text #73

Closed sebassdc closed 3 years ago

sebassdc commented 3 years ago

I was trying to use bar with a custom int increment. The docs says is the first parameter but instead is the second one.

rsalmei commented 3 years ago

Yeah, I know. I'm sorry for that, it is because the first arg text is deprecated, and I wanted to show people the new signature, which will soon be released:

For now, please just name it bar(incr=42). I thought people would become used to expect bar() had an increment in the first arg, even if it causes a few hiccups now. The signatures of both kinds of bar() are now standardized, which is even better to soothe expectations. Both support absolute and relative sets.