Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
pb-413 opened this issue May 20, 2024 · 5 comments

Comments

@pb-413
Copy link
Contributor

pb-413 commented May 20, 2024

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
Copy link
Collaborator

ucodery commented May 20, 2024

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 pb-413 changed the title Typo - Initial version code recommended is inconsistent (Major and Minor versus Major, Minor, and Patch?) Typo - Initial version code recommended is inconsistent (Major and Minor versus Major, Minor, and Patch?) - installable-code.md May 20, 2024
@pb-413
Copy link
Contributor Author

pb-413 commented May 20, 2024

Filed PR: #262

@pb-413
Copy link
Contributor Author

pb-413 commented May 21, 2024

Closing as the PR #262 has merged.

@pb-413 pb-413 closed this as completed May 21, 2024
@ucodery
Copy link
Collaborator

ucodery commented May 21, 2024

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.

@ucodery ucodery reopened this May 21, 2024
@pb-413
Copy link
Contributor Author

pb-413 commented May 21, 2024

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

Sorry about the eagerness!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

3 participants