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

Improve definitions and examples in the Grammar and mechanics guide regarding periods #1029

Open
marijnschraagen opened this issue Jul 21, 2022 · 0 comments

Comments

@marijnschraagen
Copy link

Is your feature request related to a problem? Please describe.
The Grammar and mechanics guide contains a section on when to use periods: https://stackoverflow.design/content/guidelines/grammar-and-mechanics/#periods. It states:

Don’t use periods in interface copy unless it’s a full sentence or description.

However, the section does not contain a definition on what a "full sentence" is (or "complete sentence" as it is called in the examples in the section). This leads to, or at least does not address, meta questions on the usage of periods on SE.

Also, the examples provided in different parts of the guide seem inconsistent regarding period use. For example from Verbs and nouns, no period:

Log in to ask a question

Contrast with Hyphens (with period):

Start your free 14-day trial.

Get started. Sign up today.

Describe the solution you'd like
Add a definition of what a "full sentence" or "complete sentence" is (or what it is not). A useful difference seems to be an imperative phrase (do this) vs an indicative sentence, i.e., a "regular" sentence with at minimum a subject and a verb (Your account has been suspended.). Also choose between the two terms, either "full sentence" or "complete sentence" but not both.

The guide should also mention the difference between single phrases and combinations of two or more phrases, in which each phrase should end with a period, even if it is an imperative phrase.

Explicit examples for each case should be added in the Periods section, for the following cases:

  • imperative phrase
  • combination of two or more imperative phrases
  • complete sentence

Current incorrect examples should be changed, for example:

Start your free 14-day trial.

Your job listing was published on January 15

Additional context
This feature request was prompted by https://meta.stackexchange.com/questions/380566/make-full-stop-usage-consistent-in-badge-descriptions/380592.

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

No branches or pull requests

1 participant