search

FionaQY / pe

0 stars 0 forks source link

Unnecessary and missing terms in DG Glossary #10

Open FionaQY opened 1 week ago

FionaQY commented 1 week ago

"Regex" is not mentioned one other time in both the UG and DG so there is no need to define it. Additionally, I believe telegram handles should also be explained in the Glossary due to how many times it comes up in the documentation.

image.png

soc-pe-bot commented 1 week ago

[IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]

Team's Response

Hi tester thanks for your comment but we have to reject your bug report.

The purpose of the glossary, as stated in our User Guide Quick Start section, is to help users reference complex or uncommon terms they may encounter while using the application. Regex is a technical term that many users might not know or remember, especially new users revisiting the guide. Including it in the glossary ensures clarity without cluttering the main documentation. Even if the term isn’t explicitly mentioned elsewhere, it supports user learning and retention as a foundational concept.

Here is a snippet from our user-guide#quick-start section. image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your reason]