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 docs #522

Closed
wants to merge 2 commits into from
Closed

Update docs #522

wants to merge 2 commits into from

Conversation

EduardoBautista
Copy link
Contributor

This PR will make the guide more generic in terms of directory paths and crate information. It also
updates some outdated output.

name = "hello-world" # the name of the package
version = "1.0.0" # the current version, obeying semver
authors = [ "[email protected]" ]
name = "hello_world" # the name of the package
Copy link
Contributor

Choose a reason for hiding this comment

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

For better or for worse, hyphenated package names are going to be encouraged.

#380

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For now I'm going to close this as I don't think we'd like to do this at this time, but we can certainly revisit this if it looks like it's becoming a more official trend!

Is he referring to underscores or hyphens? @alexcrichton

Copy link
Member

Choose a reason for hiding this comment

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

There is not a consistent message about this yet. http://aturon.github.io/style/naming.html "Crates snake_case (but prefer single word)"

Copy link
Member

Choose a reason for hiding this comment

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

Yes the convention around this is still under development. This is fine for now though.

bors added a commit that referenced this pull request Sep 7, 2014
This PR will make the guide more generic in terms of directory paths and crate information.  It also
updates some outdated output.
@bors bors closed this Sep 7, 2014
@EduardoBautista EduardoBautista deleted the update-docs branch September 7, 2014 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants