search

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

Typo - Initial version code recommended is inconsistent (Major and Minor versus Major, Minor, and Patch?) - installable-code.md #257

Open pb-413 opened 1 month ago

pb-413 commented 1 month ago

During the tutorial, changing the initial version in the project.toml to "0.1.0" is recommended; then, in the following example, it is listed as only "0.1".

https://github.com/pyOpenSci/python-package-guide/blob/7b422d4256cdb89d40c8b2b19227e4a5d8078817/tutorials/installable-code.md?plain=1#L393C1-L400C28

I'm a fan of Semantic Versioning, but depending on your audience and intent, consider standardizing this version representation.

Happy to take up this work; just need to know which way to lean.

ucodery commented 1 month ago

I agree this inconsistency should be resolved. I don't care too much which way but lean toward "0.1" as it is the simpler string and this is a beginner guide. To packaging tools these two versions are exactly equivilant.

pb-413 commented 1 month ago

Filed PR: #262

pb-413 commented 1 month ago

Closing as the PR #262 has merged.

ucodery commented 1 month ago

I greatly appreciate the PR, but we still have 0.1.0s in the docs elsewhere. Opening until those are fixed.

It would be nice to also lint against us doing this again in the future. That's probably a separate issue.

pb-413 commented 1 month ago

Understood! I'll take another pass over the docs.

Sorry about the eagerness!