search

EvitanRelta / pe

0 stars 0 forks source link

Minor formatting bug in UG #15

Open EvitanRelta opened 1 year ago

EvitanRelta commented 1 year ago

back ticks of "exit" not rendered properly as exit

image.png

nus-pe-bot commented 1 year ago

Team's Response

It is not a bug since it is consistent with the rest of the UG

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement:

  1. This is clearly a failed Markdown -> HTML rendering caused by your team using markdown syntax (ie. backticks in `exit` command) inside of HTML tags in ur UserGuide.md as shown:

    <p>
  <img class="diagram" src="images/ExitExample1.png" />
  <em>Exit the application with the `exit` command</em>
</p>

  2. Just because a bug occurs in the entire UG is NOT a valid reason to justify it not being a bug.

  3. Even if we go with your reasoning of it being "consistent with the rest of the UG, thus not a bug" logic, your use of backticks is in-fact not consistent in your UG, as shown that u used code-formatting in other areas (circled blue) to indicate the exit command:

    image.png