search

nus-cs2103-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Missing fullstop in section headers #3811

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

image.png

image.png

Section headers that link to the summary of commands are missing a fullstop at the end of the sentence.

A minor typo that is purely cosmetic.

[original: nus-cs2103-AY2223S1/pe-interim#3645] [original labels: severity.VeryLow type.DocumentationBug]

Devanshshah1309 commented 1 year ago

Team's Response

Hi, thanks for the bug report!

We don't feel that not including full stops in headers is a bug. It is consistent throughout the UG, i.e., we have not included full-stops for any of the headings and subheadings.

It is common to omit the full-stop in headings (since a heading is not meant to be a sentence - it is not subject to the same grammar/punctuation rules).

Quoting the Office for National Statistics,

Full stops are used to end sentences. Only use one space after them. Do not use them after initials, or in titles, abbreviations or acronyms. They also should not be used in any heading, subheading, title, date or name that occupies a line to itself.

Duplicate status (if any):

--