search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Break in `fitadd` command in table in UG #2334

Open nus-se-script opened 6 months ago

nus-se-script commented 6 months 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

As shown in screenshot, the break in the table makes it more difficult to follow for the next page, where just reading that without the above page makes no sense. Suggest to break full rows instead.

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

dillontkh commented 6 months ago

Team's Response

The break after the first example was to separate the two different formats of the fitadd command for greater visual clarity. The first was to add a single exercise, the second is to add a set of exercises.

Duplicate status (if any):

--