Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unknown index in Appendix: Instructions for manual testing in DG #6025

Open
nus-se-script opened this issue Nov 17, 2023 · 1 comment
Open

Comments

@nus-se-script
Copy link

nus-se-script commented Nov 17, 2023

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 don't know why these unknown indices exist. I guess this sentence should serve as an overview of the functionality to be tested, but the index here is actually redundant and may lead to confusion.

Screenshot 2023-11-17 at 5.28.29 PM.png

Screenshot 2023-11-17 at 5.28.33 PM.png
Screenshot 2023-11-17 at 5.28.39 PM.png


[original: nus-cs2103-AY2324S1/pe-interim#6022] [original labels: type.DocumentationBug severity.Medium]
@jianyangg
Copy link

jianyangg commented Nov 19, 2023

Team's Response

The severity can be downgrade to VeryLow as this is more of a cosmetic issue and does not impede the readability of the user.

For the sake of standardising the formatting, we aligned this numbering with the "Launch and shutdown" section under "Appendix: Instruction for manual testing".

The content of each sub-section was not unclear or cut off. We believed that this would not cause any confusion.

We could consider removing this numbering for sections that are not "Launch and shutdown" but it'll break our formatting which might lead to more confusion -- is the "Launch and shutdown" section different from other sections? Why does it then have the numbering while the rest doesn't? If we changed it to fit your suggestion, would you then raise another critique along these lines?

Duplicate status (if any):

--

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants