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.
There seems to an inconsistency or typo with the use of markdown to emphasise variable names.
Under the "rename" command section of the user guide, "NAME" and "NEW_NAME" are not encapsulated like the other variables in the user guide. Variables are circled in the screenshot below.
This is a pure cosmetic issue and does not affect the readability of the user guide as its already been specified in the user guide and variables are in all caps.
dtaywd
commented
6 months ago
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.
There seems to an inconsistency or typo with the use of markdown to emphasise variable names.
Under the "rename" command section of the user guide, "NAME" and "NEW_NAME" are not encapsulated like the other variables in the user guide. Variables are circled in the screenshot below.
This is a pure cosmetic issue and does not affect the readability of the user guide as its already been specified in the user guide and variables are in all caps.
[original: nus-cs2113-AY2324S2/pe-interim#2533] [original labels: type.DocumentationBug severity.VeryLow]