Skip to content

PYLINT.md

Latest commit

 

History

History
55 lines (39 loc) · 1.67 KB

PYLINT.md

File metadata and controls

55 lines (39 loc) · 1.67 KB

Pylint Report for Pybrary Project

Introduction

This document contains the pylint output before fixing issues, highlighting the issues that have been fixed, and the new code after fixing them. Pylint is a static code analysis tool that helps improve code quality by identifying potential errors and enforcing coding standards.

Pylint Configuration

We used the following .pylintrc configuration for our pylint analysis:

[MASTER]
ignore=tests

[MESSAGES CONTROL]
disable=
    C0114,  # Missing module docstring
    C0115,  # Missing class docstring
    C0116,  # Missing function or method docstring

[FORMAT] max-line-length=120

Pylint Output Before Fixing Issues

Below is the pylint output before fixing the identified issues:

************* Module src.gui src/gui.py:1:0: C0114: Missing module docstring (missing-module-docstring) src/gui.py:5:0: C0116: Missing function or method docstring (missing-function-docstring) src/gui.py:10:4: W0611: Unused import os (unused-import)

************* Module src.librarian src/librarian.py:1:0: C0114: Missing module docstring (missing-module-docstring) src/librarian.py:7:4: W0612: Unused variable 'unused_variable' (unused-variable) src/librarian.py:12:0: C0301: Line too long (130/120) (line-too-long)

************* Module src.library_manager src/library_manager.py:1:0: C0114: Missing module docstring (missing-module-docstring) src/library_manager.py:5:0: C0116: Missing function or method docstring (missing-function-docstring)

Issues Highlighted and Fixes

src/gui.py

Issue 1: Missing Module Docstring

Before Fix:

  • src/gui.py Fix: """ GUI Module Handles the graphical user interface of the Pybrary application. """