uprm-inso4115-2023-2024-s2 / semester-project-automated-resume-builder

semester-project-automated-resume-builder created by GitHub Classroom
1 stars 0 forks source link

[Doc Feedback] Fix context for code snippets #219

Closed irsaris closed 5 months ago

irsaris commented 6 months ago

"Fragments of your implementation and other auxiliary media (diagrams, screen designs, etc.) need to serve a purpose. You must be able to say WHY this is needed in your document, what is the point you're trying to make? Just saying e.g. "This next code snippet consists of an implementation in the experience page, when a user provides information about their work experience, they can add it as a job which then the data will be stored in a list and displayed below, this allows users to input more than one job." does not use the code snippet to make a point, the explain something, the justify a design decision, etc. In your section on BDD you could actually have included the text of the test and then have used it to reference lines within that test. The justification would be that you want to explain how you are using BDD and you need to give one example of this, but when taking the BDD test apart like you did here, the overview is lost, and so your exposition would improve having the source code of the BDD test as a whole with line numbers that you could then reference from your text."

irsaris commented 5 months ago

This is due in less than 2 hours.