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

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

Merged
merged 4 commits into from
May 23, 2024

Conversation

pb-413
Copy link
Contributor

@pb-413 pb-413 commented May 21, 2024

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

  • 0.1.0 -> 0.1
  • 0.1.1 -> 0.2

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)

didn't hit: 1) shell output examples like 'dist/pyospackage-0.1.0.tar.gz' in publish-pypi.md because I'm unsure if that would be affected, and 2) the alt text for images/tutorials/test-pypi-package.png which would need to accurately describe the image also in publish-pypi.md
@ucodery
Copy link
Collaborator

ucodery commented May 22, 2024

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 pb-413 changed the title Update version references in tutorial: 0.1.0 -> 0.1; 0.1.1 -> 0.2 Update version references in tutorial: 0.1.0 -> 0.1 May 23, 2024
@pb-413
Copy link
Contributor Author

pb-413 commented May 23, 2024

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.

Copy link
Collaborator

@ucodery ucodery left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks for the change.

And this should be enough to close the related issue. We still need to be mindful of this inconsistency going forward, but that's just part of the guide work.

@ucodery ucodery merged commit a0e1312 into pyOpenSci:main May 23, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

3 participants