nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Developer Guide: Inconsistency in capitalization #1765

Open nus-se-script opened 1 week ago

nus-se-script commented 1 week ago

Details

As can be seen from the screenshot below, the first bullet point begins with a capital letter while the remaining bullet points begin with lowercase letters. Screenshot 2024-11-15 at 5.21.57 PM.png

This appears a bit unusual as though a paragraph has been broken up by bullet points.

Suggested improvement

Standardise the formatting of the bullet points.


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

SamuelFoo commented 1 week ago

Team's Response

Thanks for pointing this out! However, this does not affect the intended meaning of our points.

Since this is a grammatical error that does not hinder the user, we will mark it as "NotInScope" according to the guidelines from the course website (see https://nus-cs2103-ay2425s1.github.io/website/admin/tp-pe.html#pe-phase-1-part-ii-evaluating-documents-30-minutes).

image.png

Duplicate status (if any):

--