Skip to content

README.md missing plot.py file in project structure #177

Description

@Goziee-git

Title: README.md missing plot.py file in project structure

Issue Description:

The project structure section in README.md is missing the plot.py file that exists in the scripts/ directory.

Current README structure:
scripts/ # Run scripts for all phases
├── 1-fetch/
├── 2-process/
├── 3-report/
└── shared.py

Expected README structure:
scripts/ # Run scripts for all phases
├── 1-fetch/
├── 2-process/
├── 3-report/
├── shared.py
└── plot.py

Steps to reproduce:

  1. Check the actual scripts/ directory - plot.py exists
  2. Compare with README.md project structure section
  3. Notice plot.py is missing from the documentation

Suggested fix:
Add the missing plot.py entry to the project structure tree in README.md with the comment "Data visualisations with matplotlib" to match the existing file's purpose.

Additional context:
The plot.py file appears to handle data visualization functionality but is not documented in the project structure, which could confuse new contributors trying to understand the
codebase organization.

Resolution

  • I would be interested in resolving this bug.

Metadata

Metadata

Assignees

Type

Fields

No fields configured for Bug.

Projects

Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions