Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Python classes to pass flake8 linter #72

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

obscurerichard
Copy link
Member

@obscurerichard obscurerichard commented Dec 31, 2024

Refactor the Python classes to pass the flake8 linter. Kind of a big job, but GitHub Copilot made an OK start on it.

  • Add docstrings to all classes, methods, and fields in the following files:

    • freezing/sync/cli/__init__.py
    • freezing/sync/cli/sync_activities.py
    • freezing/sync/cli/sync_details.py
    • freezing/sync/cli/sync_photos.py
    • freezing/sync/cli/sync_streams.py
    • freezing/sync/cli/sync_weather.py
    • freezing/sync/data/activity.py
    • freezing/sync/data/photos.py
    • freezing/sync/data/streams.py
    • freezing/sync/data/weather.py
    • freezing/sync/exc.py
    • freezing/sync/subscribe.py
    • freezing/sync/utils/cache.py
    • freezing/sync/utils/wktutils.py
    • freezing/sync/wx/darksky/api.py
  • Remove unused imports in the following files:

    • freezing/sync/autolog.py
    • freezing/sync/cli/__init__.py
    • freezing/sync/config.py
    • freezing/sync/run.py

For more details, open the Copilot Workspace session.

Refactor the Python classes to pass the flake8 linter.

* Add docstrings to all classes, methods, and fields in the following files:
  - `freezing/sync/cli/__init__.py`
  - `freezing/sync/cli/sync_activities.py`
  - `freezing/sync/cli/sync_details.py`
  - `freezing/sync/cli/sync_photos.py`
  - `freezing/sync/cli/sync_streams.py`
  - `freezing/sync/cli/sync_weather.py`
  - `freezing/sync/data/activity.py`
  - `freezing/sync/data/photos.py`
  - `freezing/sync/data/streams.py`
  - `freezing/sync/data/weather.py`
  - `freezing/sync/exc.py`
  - `freezing/sync/subscribe.py`
  - `freezing/sync/utils/cache.py`
  - `freezing/sync/utils/wktutils.py`
  - `freezing/sync/wx/darksky/api.py`

* Remove unused imports in the following files:
  - `freezing/sync/autolog.py`
  - `freezing/sync/cli/__init__.py`
  - `freezing/sync/config.py`
  - `freezing/sync/run.py`

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/freezingsaddles/freezing-sync?shareId=XXXX-XXXX-XXXX-XXXX).
@obscurerichard obscurerichard added this to the 2025 - Competition End milestone Dec 31, 2024
@obscurerichard obscurerichard added enhancement New feature or request help wanted Extra attention is needed labels Jan 1, 2025
@obscurerichard obscurerichard marked this pull request as draft January 1, 2025 01:10
Base automatically changed from master to main January 3, 2025 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
Status: In progress
Development

Successfully merging this pull request may close these issues.

1 participant