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 applications and update instructions #66

Merged
merged 7 commits into from
Jun 5, 2024
Merged

Refactor applications and update instructions #66

merged 7 commits into from
Jun 5, 2024

Conversation

gpauloski
Copy link
Contributor

@gpauloski gpauloski commented Jun 5, 2024

Description

This PR does a run through of all the applications to:

  • Refactor and update docstrings for clarity and code health
  • Validate dependency installation works
  • Test data installation instructions are present and work
  • Update the application guide
  • Improve logging where needed

This is a breaking change because some application parameter names changed.

Fixes

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (internal implementation changes)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (no changes to the code)
  • CI change (changes to CI workflows, packages, templates, etc.)
  • Version changes (changes to the package or dependency versions)

Testing

Tested all applications.

Pull Request Checklist

Please confirm the PR meets the following requirements.

  • Relevant tags are added (breaking, bug, dependencies, documentation, enhancement, refactor).
  • Code changes pass pre-commit (e.g., ruff, mypy, etc.).
  • Tests have been added to show the fix is effective or that the new feature works.
  • New and existing unit tests pass locally with the changes.
  • Docs have been updated and reviewed if relevant.

@gpauloski gpauloski added breaking Backwards incompatible change to public interfaces documentation Improvements or additions to documentation internal Refactoring, style changes, testing, or code optimizations labels Jun 5, 2024
@gpauloski gpauloski force-pushed the issue-58 branch 2 times, most recently from 45aa5f0 to 9031ab4 Compare June 5, 2024 03:02
@gpauloski gpauloski merged commit 7475cd5 into main Jun 5, 2024
7 checks passed
@gpauloski gpauloski deleted the issue-58 branch June 5, 2024 03:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking Backwards incompatible change to public interfaces documentation Improvements or additions to documentation internal Refactoring, style changes, testing, or code optimizations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Revise application code and documentation
1 participant