Open RainyCodeWizard opened 3 years ago
No response provided.
[The team marked this bug as a duplicate of the following bug]
UG - Some examples are cut off by page break
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.
It may be more neat to insert page breaks before the example, so that they are printed on the same page.
[original: nus-cs2113-AY2021S2/pe-interim#989] [original labels: severity.Low type.DocumentationBug]
[This is the team's response to the above 'original' bug]
It is rendered properly on the website. We overlooked the conversion by doing Ctrl + P and failed to notice this.
Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)
Reason for disagreement: The 'Original' bug is talking the document printing across 2 different pages for an output. However, I am talking about the text in Markdown getting cutoff for long line texts. This is different from what the 'Original' bug is reporting. In the 'Original' bug, there is no loss of information as users can just scroll down. But, in my bug there is a loss of information as the right part gets cut off.
Team chose [severity.Low
]
Originally [severity.Medium
]
Reason for disagreement: [replace this with your explanation]
Throughout the whole UG, program outputs are shown in a markdown format. This brings various disadvantages to the user. One such problem is this:
Often text gets cutoff and sentence is not completed. Also, it is better to provide images of the actual output as the user can compare with his/her own output and understand better.
Please use images to show the program output.