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

Guidelines or policy on grammar and style #39

Open
ehuss opened this issue Mar 1, 2024 · 0 comments
Open

Guidelines or policy on grammar and style #39

ehuss opened this issue Mar 1, 2024 · 0 comments
Labels
C-meta Category: Meta discussion about the repository itself. We should refine each use of the policy label

Comments

@ehuss
Copy link
Contributor

ehuss commented Mar 1, 2024

Should there be guidelines or policy on English grammar and style? Some examples:

  • Should there be a preference for a specific external style guide, like AP Style, APA, Chicago, MLA, etc.?
  • Grammatic person guidelines? Voice?
  • Oxford commas.
    • ehuss's preference is yes.
  • Avoid slashes for alternatives ("program/binary"), use conjunctions or rewrite it ("program or binary")
    • ehuss's preference is yes.
  • Avoid qualifying something as "in Rust".
    • ehuss's preference is yes. Contributors to the Reference often start their sentences "In Rust, ...". That should always be removed. Almost every sentence in the spec is about Rust.
  • Should the spec be agnostic about whether code is "compiled" or "interpreted"? Should it avoid using the term "compile"?
    • ehuss's preference: I think it would be good to avoid talking about "the compiler" or "... is compiled to ..." unless absolutely necessary.
  • Any guidance on contractions?
  • Phrasing for editions should be "the 20xx Edition", not "Rust 2024", not "Edition 2024"
@JoelMarcey JoelMarcey added C-meta Category: Meta discussion about the repository itself. We should refine each use of the policy label and removed t-spec meeting discussion labels Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-meta Category: Meta discussion about the repository itself. We should refine each use of the policy label
Development

No branches or pull requests

2 participants