search

boonhaii / pe

0 stars 0 forks source link

Different Formatting for Design Considerations Subsection. #11

Open boonhaii opened 2 years ago

boonhaii commented 2 years ago

In the section under "Schedule" the formatting was as such: Screenshot 2021-11-12 at 5.28.08 PM.png

However, in the section "find", the formating of the subsection was different and thus inconsistent. Screenshot 2021-11-12 at 5.29.04 PM.png

nus-pe-bot commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

DG - Different formatting for "Design considerations" of each command

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.

I noticed that there are different ways the formatting was done for the design considerations under the "Implementation" section of the DG. I think sticking to one style would provide much more consistency.

Some examples I have found are shown below:

Find command:

image.png

Payment tracking: (this format seems to be the most popular)

image.png

Education level:

image.png

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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

No details provided by team.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]