python-package-guide icon indicating copy to clipboard operation
python-package-guide copied to clipboard

Typos in decision tree diagram

Open kwinkunks opened this issue 2 years ago • 2 comments

The decision tree diagram is awesome -- very helpful I think. Thank you for making it.

I spotted some possible typos:

  • There's a missing closing parenthesis in the italic note at the top.
  • The PDM back-end is called pdm-backend.
  • I think it would be clearer to write "e.g." instead of "i.e." for the pdm-backend remark.

FWIW, I find the two italic footnotes a bit oddly placed. The one at the top would be better placed next to the "Choices: PDM, Poetry" circle. It could probably be shortened to "Consider starting with the default back-end for your front-end tool."

Personally I think the "**Build" footnote is unnecessary and might just be confusing to a new packager. Maybe something somewhere needs to explain what's meant by 'front-end' and 'back-end'.

Last thing: some of the arrows overlay the text, and there are some other little graphical glitches that are a bit distracting (eg on some of the YES text on the left).

If you push the SVG to the repo I'm happy to help with the graphics if you want.

kwinkunks avatar Mar 28 '23 08:03 kwinkunks

oh thank you!! that would be wonderful. i've been using inkscape and have attached an svg.

The build issue - that was added because someone else thought should be in the diagram given so many

people use it. I think it's important but honestly even i was confused when i got started about what are build front ends / user interfaces vs what is a build back end. so i've been really grappling with how to describe these tools that are technicall front ends (Build) but do only one thing AND require a backend selection. hope that makes sense. python-package-tools-decision-tree

many thanks for the help!

lwasser avatar Mar 28 '23 18:03 lwasser

it seems i can't attach as an attachment. it wanted to embed it. but it also can be found here: https://github.com/pyOpenSci/python-package-guide/blob/main/images/python-package-tools-decision-tree.svg

lwasser avatar Mar 28 '23 18:03 lwasser