Skip to content

Question about the project name #46

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

Closed
shenxianpeng opened this issue Sep 25, 2024 · 5 comments
Closed

Question about the project name #46

shenxianpeng opened this issue Sep 25, 2024 · 5 comments
Labels
question Further information is requested

Comments

@shenxianpeng
Copy link
Contributor

shenxianpeng commented Sep 25, 2024

Just curious, the project was named with an underscore instead of a hyphen. It might be more common to use a hyphen, setuptools-scm renamed recently. Maybe this isn't the case for the Rust project.

@shenxianpeng shenxianpeng added the question Further information is requested label Sep 25, 2024
@2bndy5
Copy link
Collaborator

2bndy5 commented Sep 25, 2024

I agree. I was afraid to mess up things. There are some external integrations that would need to be updated as well

  • ReadTheDocs
  • PyPI
  • testPyPI
  • crates-io
  • npm
  • any other links to the project.

I have to look into this more. I'm not sure if it's possible after publishing some pre-releases.

@2bndy5
Copy link
Collaborator

2bndy5 commented Sep 28, 2024

The repo name uses underscores, but all packages published use hyphens (see install instructions in README). Did you want to rename the repo?

@shenxianpeng
Copy link
Contributor Author

It would make sense to rename the repo to align with the package naming conventions.

@2bndy5
Copy link
Collaborator

2bndy5 commented Sep 28, 2024

I'm worried it might mess up package indexes (npmjs, pypi, crates-io). I'll try it out after I get #47 merged. I plan on another pre-release candidate. It may be more work than it is worth though.

@2bndy5
Copy link
Collaborator

2bndy5 commented Sep 29, 2024

done. I had nothing to worry about.

@2bndy5 2bndy5 closed this as completed Sep 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants