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

Namespace cleanup #408

Merged
merged 15 commits into from
Nov 30, 2023
Merged

Namespace cleanup #408

merged 15 commits into from
Nov 30, 2023

Conversation

thomaspinder
Copy link
Collaborator

Type of changes

  • Bug fix
  • New feature
  • Documentation / docstrings
  • Tests
  • Other

Checklist

  • I've formatted the new code by running poetry run pre-commit run --all-files --show-diff-on-failure before committing.
  • [-] I've added tests for new code.
  • [-] I've added docstrings for the new code.

Description

This PR cleans up the package's namespace, as per Slack discussions.

Issue Number: N/A

@thomaspinder thomaspinder self-assigned this Nov 6, 2023
@thomaspinder thomaspinder added the style Style label Nov 6, 2023
@thomaspinder thomaspinder added this to the v1.0.0 milestone Nov 6, 2023
gpjax/__init__.py Outdated Show resolved Hide resolved
integrators,
)
from gpjax.base import (
Module,
Copy link
Contributor

@st-- st-- Nov 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's probably better to be consistent but gpjax.Module (and perhaps the param_field) is the one thing I would've just kept in the "top-level" namespace.

Edit: actually, Dataset is in the top-level namespace as well so maybe that's an argument to keep Module, too?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved in forthcoming commit

Copy link
Contributor

@st-- st-- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, and overall I'm very happy with these changes - though I would

  • suggest (but not bother arguing about) keeping Module and param_field in the top-level name-space
  • strongly suggest (and be willing to argue) that this is breaking and bump the version to 0.8.0 to follow semantic versioning
  • there's pending merge conflicts that I've not reviewed

@thomaspinder thomaspinder merged commit 07d99db into main Nov 30, 2023
11 of 12 checks passed
@thomaspinder thomaspinder deleted the namespace_cleanup branch November 30, 2023 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
style Style
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants