Comments (1)
Team's Response
Should be purely cosmetic.
Items for the Tester to Verify
❓ Issue severity
Team chose [severity.VeryLow
]
Originally [severity.Low
]
- I disagree
Reason for disagreement: The use of the emphasis (bold, italics, markdown
) was quite prevalent throughout the whole DG, especially markdown
since many classes were mentioned in the DG. As the DG is extremely wordy and content-heavy, the use of emphasis is crucial in making the document more digestible for readers.
For example, bold text may signal to readers that the section bolded contains important information for future developers, while italics may represent terms that will be defined in the glossary. However, I believe that the emphasis is meaningless without any context, and in this case, the team did not provide readers with the necessary explanation of the emphasis used. Readers may potentially miss out on certain important details, and may also get confused by the different text styles.
Hence, I stand by my original severity level of severity.Low
as this is not a mere cosmetic bug, it in fact affects the reader experience due to the reasons mentioned.
from pe.
Related Issues (15)
- [TEST] UI bug
- Edit student: use index of the student list within module instead if typing out the whole ID HOT 1
- Task ID not clear on UI HOT 1
- Mismatch between format of commands in app and UG HOT 1
- Mark task command marks all task under student as done HOT 1
- Unmark task not working as expected HOT 1
- mark undone marks all task as undone HOT 1
- Screenshots in delete module not self explanatory HOT 1
- Messy formatting under Features HOT 1
- Image does not match example in mark undone HOT 1
- Screenshots under edit task not sufficient to show edits HOT 1
- Unclear which example command is being executed in the images HOT 1
- No purpose of DG and intro to app in DG HOT 1
- No end of lifeline for several sequence diagrams in DG HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pe.