search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Unclear meaning of hammer emoji #5542

Open nus-se-script opened 1 month ago

nus-se-script commented 1 month 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.

Screen Shot 2567-04-19 at 17.12.45.png

Screen Shot 2567-04-19 at 17.13.32.png Screen Shot 2567-04-19 at 17.14.08.png

I saw a few hammer emoji inside the UG which I am not sure what does it refer to and it was not mentioned on the symbol guide. If there it is not a symbol of something like the information or ! symbol, it is a bit distracting and inconsistent to me as most of the parts emojis are not used if it is not a symbol referring to something.

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

kaitinghh commented 1 month ago

Team's Response

The hammer emoji is not a symbol that is used to signify something in the user guide, and hence it was not included in the symbol guide.

The purpose of the hammer emoji was purely decorative 🔨(used to satisfy the requirements of CS2101). Users may encounter it throughout the document, but its presence is purely ornamental and doesn't carry any particular meaning or function beyond that.

Therefore, there is no confusion to be caused and does not affect the quality of the documentation.

Duplicate status (if any):

--