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

style-guide: Clarify grammar for small patterns (not a semantic change) #113384

Merged
merged 2 commits into from Jul 6, 2023

Conversation

joshtriplett
Copy link
Member

The grammar as written feels ambiguous and confusing, in large part
because it uses square brackets and commas in the names of
non-terminals. Rewrite it to avoid symbols in the names of
non-terminals, and to instead wrap terminals in backquotes.

Also rename "smallntp" to "small_no_tuple" to make it self-describing.

The grammar as written feels ambiguous and confusing, in large part
because it uses square brackets and commas in the names of
non-terminals. Rewrite it to avoid symbols in the names of
non-terminals, and to instead wrap terminals in backquotes.
…larity

The meaning of "smallntp" was not immediately obvious at a glance.
Rename it to the self-describing "small_no_tuple"
@rustbot
Copy link
Collaborator

rustbot commented Jul 5, 2023

r? @compiler-errors

(rustbot has picked a reviewer for you, use r? to override)

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

rustbot commented Jul 5, 2023

Some changes occurred in src/doc/style-guide

cc @rust-lang/style

@compiler-errors
Copy link
Member

wow yeah that [small, ntp] is super hard to read 😅

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jul 5, 2023

📌 Commit 79df44b has been approved by compiler-errors

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 Jul 5, 2023
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 6, 2023
…fee1-dead

Rollup of 9 pull requests

Successful merges:

 - rust-lang#111119 (style-guide: Add chapter about formatting for nightly-only syntax)
 - rust-lang#112791 (llvm ffi: Expose `CallInst->setTailCallKind`)
 - rust-lang#113145 (style-guide: Document newline rules for assignment operators)
 - rust-lang#113163 (Add a regression test for rust-lang#112895)
 - rust-lang#113332 (resolve: Use `Interned` for some interned structures)
 - rust-lang#113334 (Revert the lexing of `c"…"` string literals)
 - rust-lang#113350 (Fix the issue of wrong diagnosis for extern pub fn)
 - rust-lang#113371 (Fix submodule handling when the current branch is named after a tag)
 - rust-lang#113384 (style-guide: Clarify grammar for small patterns (not a semantic change))

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit c668eb0 into rust-lang:master Jul 6, 2023
11 checks passed
@rustbot rustbot added this to the 1.72.0 milestone Jul 6, 2023
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Aug 1, 2023
…t, r=calebcartwright

style-guide: Document style editions, start 2024 style edition

Link to a snapshot for the 2015/2018/2021 style edition.

This is a draft, because I'd like to wait for a few style guide fixes to merge
before snapshotting the 2015/2018/2021 style edition:

- rust-lang#113145
- rust-lang#113380
- rust-lang#113384
- rust-lang#113385
- rust-lang#113386
- rust-lang#113392

I'd like to wait for these for two reasons: to make it easier to see the
differences between the 2015/2018/2021 style edition and the 2024 style
edition (without the noise of guide-wide changes), and to minimize confusion so
that bugfixes to the style guide that we include in the previous edition don't
look like they're only part of the 2024 style edition.

I've used "Miscellaneous `rustfmt` bugfixes" as a starting point for the list
of 2024 changes, for now. We can update that when we add more 2024 changes.

The section added in this PR can then serve as a baseline for our drafts of
2024 style edition changes.

In the meantime, I'd like to get someone from `@rust-lang/style` to review and
approve the text here; I'll update it with a commit hash when the above PRs
have merged.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-style Relevant to the style team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants