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.

Sign up for GitHub

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

Jump to bottom

docs: wrong naming convention in struct keyword doc #108272

Merged
merged 2 commits into from
Feb 21, 2023
Merged

docs: wrong naming convention in struct keyword doc #108272

merged 2 commits into from
Feb 21, 2023

Conversation

mrnossiom
Copy link
Contributor

@mrnossiom mrnossiom commented Feb 20, 2023 •
edited
Loading

Noticed that the naming convention mentioned is not the right one.

As far as I know, PacalCase is the naming convention used for structs names. PacalCase is not the same as camelCase

@rustbot
Copy link
Collaborator

rustbot commented Feb 20, 2023

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @thomcc (or someone else) soon.

Please see the contribution instructions for more information.

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Feb 20, 2023
@rustbot
Copy link
Collaborator

rustbot commented Feb 20, 2023

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs

@kadiwa4
Copy link
Contributor

kadiwa4 commented Feb 20, 2023

Some people refer to both of them as camel case, I think that's pretty common in the Rust world (e.g. see the naming convention (which calls it upper camel case) or heck (which accepts both names))

@thomcc
Copy link
Member

thomcc commented Feb 20, 2023

I think rust-lang/rfcs#2389 is precedent that we should call it UpperCamelCase instead of PascalCase.

@mrnossiom
Copy link
Contributor Author

mrnossiom commented Feb 20, 2023 •
edited
Loading

I didn't know that camelCase applied to both cases (lower and upper).
As @thomcc says, using UpperCamelCase instead of CamelCase may seem less odd and more explicit to people that come from languages where lower camel case is the main naming convention (e.g. JS).

@thomcc
Copy link
Member

thomcc commented Feb 20, 2023

Sure. Seems fine to call it UpperCamelCase and is in line with the decision in the RFCs repo.

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Feb 20, 2023

📌 Commit 18f5f0c has been approved by thomcc

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 20, 2023
@Dylan-DPC Dylan-DPC mentioned this pull request Feb 21, 2023
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 21, 2023
@bors
Auto merge of rust-lang#108301 - Dylan-DPC:rollup-70zpkt0, r=Dylan-DPC
bda32a4 
Rollup of 7 pull requests

Successful merges:

 - rust-lang#108000 (lint: don't suggest MaybeUninit::assume_init for uninhabited types)
 - rust-lang#108105 (Explain the default panic hook better)
 - rust-lang#108141 (Add rpitit queries)
 - rust-lang#108272 (docs: wrong naming convention in struct keyword doc)
 - rust-lang#108285 (remove unstable `pick_stable_methods_before_any_unstable` flag)
 - rust-lang#108289 (Name placeholder in some region errors)
 - rust-lang#108290 (Add a test for default trait method with RPITITs)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 7dcf7fe into rust-lang:master Feb 21, 2023
@rustbot rustbot added this to the 1.69.0 milestone Feb 21, 2023
@mrnossiom
Copy link
Contributor Author

Btw, it is kind of funny that my first PR to the Rust lang was the day of my birthday

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@thomcc thomcc

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.69.0
Development

Successfully merging this pull request may close these issues.
5 participants
@mrnossiom @rustbot @kadiwa4 @thomcc @bors