DarrachBarneveld / ci-swag

Project 5 for Code Institute - Diploma in Full Stack Software Development (E-commerce Applications)
0 stars 2 forks source link

User Story: Docstrings #68

Closed DarrachBarneveld closed 6 months ago

DarrachBarneveld commented 6 months ago

As a developer, I can ensure that all code is thoroughly documented with comments in a standardised format so that anyone reading the code can easily understand its purpose

Acceptance Criteria:

  1. All Python code must have comments explaining the purpose of each function, class, and significant blocks of code.
  2. JavaScript code should be documented with comments describing the functionality of each function, event handler, and complex logic.
  3. CSS code must include comments to clarify the styling rules, layout decisions, and any browser-specific considerations.
  4. The comments should follow a consistent format, including descriptions, parameter explanations, and any relevant references or documentation links.

Tasks

DarrachBarneveld commented 6 months ago

All custom code documented