Split the step_completed function

[erikbern]

Not a Fowler zealot but in this case I think this is very true: https://martinfowler.com/bliki/FlagArgument.html

Also think it's a bit silly to have documentation for this function for what's basically just adding a symbol

[modal-pr-review-automation]

Auto-approved 👍. This diff qualified for automatic approval and doesn't need follow up review.

[mwaskom]

My reasoning here is that the separate methods communicate more clearly what my intention is when I make the call. Instead of having to remember the meaning of the flag variable when I see book(martin, false) I can easily read regularBook(martin).

FWIW I think this is completely moot in languages where you can pass an explicit keyword. Totally agree that do_something(arg, True) is really ambiguous and makes it hard to read the code, but do_something(arg, force=True) is very clear.

That said, any individual function with a flag may make more sense from a code organization perspective to be split into two functions — seems like the case here! — I just don't think the main code readability argument there is relevant in Python.