Giter Club home page Giter Club logo

Comments (1)

nus-pe-bot avatar nus-pe-bot commented on July 29, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.