pyOpenSci / python-package-guide

scientific Python package recommendations & guidance curated by pyOpenSci
https://www.pyopensci.org/python-package-guide/
Other
70 stars 43 forks source link

Update version references in tutorial: 0.1.0 -> 0.1 #279

Closed pb-413 closed 1 month ago

pb-413 commented 1 month ago

Updated most remaining references to version from three number to two number versions:

I did not touch the following. Let me know if that is desired: 1) References to version in example shell output because I'm not 100% sure if that would change; I suspect it would , but would like to confirm. e.g. dist/pyospackage-0.1.0.tar.gz etc. in publish-pypi.md 2) Reference inside an image alt text, where I suspect the alt text should correctly describe the image (also in publish-pypi.md) 3) References outside of tutorials/

(Continuation of #257)

ucodery commented 1 month ago

I'm not as sure about the need for 0.1.1 -> 0.2. The number of numeral positions on the first version does not lock the project in to not using patch numbers later on. For new examples in the docs I am fine if the author wants to write 0.1 or 0.1.1 or 0.2, or even 0.1.0.1. We are changing some version strings in #257 because they normalize to the same value, and we were being inconsistent.

  1. you are correct, the filename will change
  2. if 0.1.0 appears in the image, it should be left yes, otherwise we should remain consistent. Also @lwasser should be able to regenerate images to remove the.0 since this issue is about consistency.
  3. totally fine. We also have references in tests/ which would be nice to change, and in examples/ which is a very in-flux area right now and should probably get changes as we introduce tests to that area.
pb-413 commented 1 month ago

Good point about version number flexibility. Made changes accordingly (0.2 -> 0.1.1). Great to learn about equivalence too, thanks!

Also changed the filenames in example dist lines (pyospackage-0.1.0.tar.gz -> pyospackage-0.1.tar.gz).

Left the image alt text and stayed in tutorials/ again because that felt like a good scope to keep to.