Skip to content

Refactor import structure to simplify imports and docs#92

Merged
gpauloski merged 4 commits intomainfrom
flatten-namespaces
Jul 12, 2024
Merged

Refactor import structure to simplify imports and docs#92
gpauloski merged 4 commits intomainfrom
flatten-namespaces

Conversation

@gpauloski
Copy link
Copy Markdown
Contributor

Description

Refactor import structure to simplify imports and docs. Many subpackages are now "private" with their public APIs re-exported in the parent packages __init__.py. Docstrings have also been improved.

Fixes N/A

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

Test pass.

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 internal Refactoring, style changes, testing, or code optimizations labels Jul 12, 2024
@gpauloski gpauloski merged commit 50697aa into main Jul 12, 2024
@gpauloski gpauloski deleted the flatten-namespaces branch July 12, 2024 23:02
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 internal Refactoring, style changes, testing, or code optimizations

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant