search

LouisLouis19 / pe

0 stars 0 forks source link

Inconsistency with styling #21

Open LouisLouis19 opened 2 years ago

LouisLouis19 commented 2 years ago

In the architecture section, you styled the methods, like execute() here. Screenshot 2021-11-12 at 5.29.18 PM.png

However, in the implementation section, methods are not styled in the same way. Perhaps having a consistent styling would help Screenshot 2021-11-12 at 5.30.23 PM.png

soc-pe-bot commented 2 years ago

Team's Response

This bug doesn't affect the quality of the documentation and users would still be able to understand that the documentation is referring to methods.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thank you for the response! I believe that throughout your project you would want to make it look as if it is written by one person to adhere to the project quality standards. Therefore, the difference in styling formats, I believe, should be considered as a valid cosmetic issue which is a low severity documentation bug.

Moreover, stating that this styling difference does not affect readers would be an understatement, as readers might just want to skim through the document and identify existing methods through a specific styling applied at the beginning of the document.