Whleee / pe

0 stars 0 forks source link

Inconsistent Bolding of words in the UG Links. #9

Open Whleee opened 4 years ago

Whleee commented 4 years ago

Description of issue:

In page 1 of the UG, under Bidder features and Seller features, there is inconsistent bolding of some words that is not present in any other links.

Additonal details/ screenshot:

Screenshot 2020-11-13 at 1.23.41 PM.png

nus-se-bot commented 3 years ago

Team's Response

I decided to bold bidder and seller in such a way due to the extreme similiarity in both commands, as well as the parameters needed for it.

While one might argue that the same can be applied for Meeting, Bid and Property, the parameters needed are drastically different, and hence do not justify such formatting. In addition, as one read the user guide, one is reading the from bidder to seller, and may easily be confused given the similiarity.

As you traverse downward, the bolding of the entire "Bidder / Seller" reinforces the fact you are viewing "Bidder" or "Seller". This formatting was well intended, and not in any way a bug of the documentation. If at all, it may be a subjective preference of the reader if they do not like it, or actually find it helpful.

The only difference between seller and bidder is only in the -b and -s, which can be equally confusing if not distinctively identified with such bolding. The formatting of bolding between both seller and bidder are consistent.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]


:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: [replace this with your explanation]