jocelyn-soh / pe

0 stars 0 forks source link

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

Open jocelyn-soh opened 5 months ago

jocelyn-soh commented 5 months ago

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.

soc-se-bot commented 5 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.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Firstly, I disagree that a page break adds "greater visual clarity" by separating the two formats into different parts/pages. Instead, I think it creates greater inconvenience because the reader has to scroll up and down to view the fitadd command in its entirety.

Secondly, based on the developers' response, it seems as though the page break was intentional since the fitadd command has 2 different formats. Hence, I would expect that for all commands with multiple formats, there would be page breaks to split up the formats (though I think it is illogical to do so as that will create a lot of extra white space between pages). However, for thefitdelete and note commands which also have 2 different formats each, there is no intentional page break for both commands in the same table, as shown in the screenshot below.

image.png Hence, I would like to disagree with their response as it is flawed and inconsistent with what is reflected in the DG for the other commands.