randallnhr / pe

0 stars 0 forks source link

Unclear description of the freeze and unfreeze commands in the UG. #14

Open randallnhr opened 1 year ago

randallnhr commented 1 year ago

image.png

Not sure if its a skill issue, but I am still unsure as to what the freeze and unfreeze command does.

The addition of a before and after image might be helpful to explain its functionality.

nus-pe-script commented 1 year ago

Team's Response

Thanks for your (+ everyone else's :o) feedback on the matter.

The primary purpose of freeze is to defend filter against mass edit and mass delete_tag commands: the latter two commands can (intentionally) drop many visible results from a filtered list, which could make it difficult for the user to perform further commands on the list. freeze freezes the visible list to prevent that.

The documentation is easier to understand after having experienced that context directly; admittedly, it is difficult to explain the purpose of freeze without it.

As the freeze command itself is also only really used in that context, not using it elsewhere will not hinder a user very much. Accordingly, we have judged the severity of this documentation bug as Low.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]