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

doc: Package name: hello_world or hello-world ? #6700

Closed
behnam opened this issue Feb 26, 2019 · 2 comments
Closed

doc: Package name: hello_world or hello-world ? #6700

behnam opened this issue Feb 26, 2019 · 2 comments
Labels
C-bug Category: bug

Comments

@behnam
Copy link
Contributor

behnam commented Feb 26, 2019

Problem
In https://doc.rust-lang.org/cargo/reference/manifest.html, we have:

name = "hello_world" # the name of the package

The same on master: https://github.com/rust-lang/cargo/blob/master/src/doc/src/reference/manifest.md#L12

But the common package name pattern (on crates.io and rest of the community) is to use hyphen-minus, like hello-world, and not underscore (hello_world).

Possible Solution(s)

Assuming that it's not intentional to use underscore (for some system compatibility reason), I think it's better to rename that like to use hyphen-minus.

What do you think?

@behnam behnam added the C-bug Category: bug label Feb 26, 2019
@dwijnand
Copy link
Member

But the common package name pattern (on crates.io and rest of the community) is to use hyphen-minus, like hello-world, and not underscore (hello_world).

I don't have pure data, but a casual glance at the front page of https://crates.io/ today actually shows more underscore usage than hyphen-minus (a few crates related to swc_ecma_parser released).

Anyways this changed in #522 and this issue seems duplicate of rust-lang/book#1709. But also here's a few more hyphen-minus vs underscore issues:

@dwijnand
Copy link
Member

dwijnand commented Mar 8, 2019

Closing as in ok status quo, as explained in rust-lang/book#1709, with a better future tracked in #2775.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: bug
Projects
None yet
Development

No branches or pull requests

2 participants