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

Tell GitHub to highlight config.toml.example as TOML #83431

Merged
merged 1 commit into from
Mar 27, 2021

Conversation

camelid
Copy link
Member

@camelid camelid commented Mar 24, 2021

This should be a nice small quality of life improvement when looking at
config.toml.example on GitHub or looking at diffs of it in PRs.

This should be a nice small quality of life improvement when looking at
`config.toml.example` on GitHub or looking at diffs of it in PRs.
@camelid camelid added the A-meta Area: Issues & PRs about the rust-lang/rust repository itself label Mar 24, 2021
@rust-highfive
Copy link
Collaborator

r? @Mark-Simulacrum

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 24, 2021
@jyn514
Copy link
Member

jyn514 commented Mar 24, 2021

I wish we could just rename it to config.example.toml - @Mark-Simulacrum do you think that would break too many scripts? Maybe we could make config.toml.example a symlink somehow?

@Mark-Simulacrum
Copy link
Member

Hm, seeing as we don't expect people to edit it directly really, why do you think such a change is a good idea? It does have some churn cost and doesn't seem particularly meaningful to humans? I'm inclined to just approve this PR (which seems like a small win).

@jyn514
Copy link
Member

jyn514 commented Mar 24, 2021

This PR doesn't fix it for editing with vim or other editors I think.

I'm inclined to just approve this PR (which seems like a small win).

Sure, this is definitely a strict improvement - I just think it would be nice to make the fix more general. I'm sympathetic to not wanting churn though.

@shirshak55
Copy link
Contributor

shirshak55 commented Mar 24, 2021

i still prefer config.toml.example rather than config.example.toml because:

  1. cp config.t (press tab) and remove .example part (for config.example.toml its relatively hard?)
  2. After opening config.toml editor like vscode informs me i should install toml extension anyway
  3. In windows I can sort .example as file type so that I know which which file should I copy and rename.

@Mark-Simulacrum
Copy link
Member

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Mar 26, 2021

📌 Commit b3ae90b has been approved by Mark-Simulacrum

@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 Mar 26, 2021
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Mar 26, 2021
…s, r=Mark-Simulacrum

Tell GitHub to highlight `config.toml.example` as TOML

This should be a nice small quality of life improvement when looking at
`config.toml.example` on GitHub or looking at diffs of it in PRs.
JohnTitor added a commit to JohnTitor/rust that referenced this pull request Mar 27, 2021
…s, r=Mark-Simulacrum

Tell GitHub to highlight `config.toml.example` as TOML

This should be a nice small quality of life improvement when looking at
`config.toml.example` on GitHub or looking at diffs of it in PRs.
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 27, 2021
Rollup of 9 pull requests

Successful merges:

 - rust-lang#83239 (Remove/replace some outdated crates from the dependency tree)
 - rust-lang#83328 (Fixes to inline assmebly tests)
 - rust-lang#83343 (Simplify and fix byte skipping in format! string parser)
 - rust-lang#83388 (Make # pretty print format easier to discover)
 - rust-lang#83431 (Tell GitHub to highlight `config.toml.example` as TOML)
 - rust-lang#83508 (Use the direct link to the platform support page)
 - rust-lang#83511 (compiletest: handle llvm_version with suffix like "12.0.0libcxx")
 - rust-lang#83524 (Document that the SocketAddr memory representation is not stable)
 - rust-lang#83525 (fix doc comment for `ty::Dynamic`)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 9df2b5f into rust-lang:master Mar 27, 2021
@rustbot rustbot added this to the 1.53.0 milestone Mar 27, 2021
@camelid camelid deleted the config-example-gitattributes branch March 28, 2021 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-meta Area: Issues & PRs about the rust-lang/rust repository itself S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants