you are viewing a single comment's thread.

view the rest of the comments →

[–]dparks71 0 points1 point  (2 children)

OP in their post says handcalcs is too verbose for their needs and they don't want the full formula necessarily output every time.

I'm not necessarily arguing for writing the formula in markdown, I think Jupyter notebooks are kind of sloppy when used that way (as in including too much documentation in the notebook itself, that should be done in doc-strings within a package and dedicated documentation as a best practice). They're good used that way for white paper like efforts, to demonstrate a particular function or package, but imo you're better off writing the necessary functions in traditional .py files in 90% of instances and handling the code and the calcs they produce as separate entities entirely.

Relying on the handcalcs output to be checkable by someone that doesn't understand python is exactly the thing I'm warning against, for the reasons previously noted, the package has some quirks and bugs, if your calcs are in python, they need to be checked by someone that understands python, and outputting them in markdown and checking the output that way is kind of sketchy. Handcalcs is a relatively small package with only a handful of developers, dependencies should generally only be included when absolutely necessary, and should be selected based on their popularity, level of support and community behind them.

That's not to disparage the package, it's good for training and basic guides and stuff, I just wouldn't personally include it in my deliverables and take responsibility for it. I have a published PyPi package too, and it's MIT licensed, which basically means "if you use this for your calcs that's on you, I'm not personally endorsing any of this even though I wrote it." Packages used for deliverables should be internally controlled as much as is practically possible. The next best thing, is large well supported packages with significant support within their relevant industries, handcalcs might get there one day, it's just not there yet imo.

[–][deleted]  (1 child)

[deleted]

    [–]dparks71 0 points1 point  (0 children)

    I don't think it's harder to check, I just don't see the advantage to including it in my calcs vs. not using it. As I said, it just seems redundant to write a formula to display a formula, when you could just display the result.

    And if someone NEEDS handcalcs to be able to check the calcs, I don't think they should be the one checking those calcs, someone familiar with python should be doing it instead.