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

Reduce argument passing-down in the API #843

Open
trexfeathers opened this issue Jun 20, 2024 · 0 comments
Open

Reduce argument passing-down in the API #843

trexfeathers opened this issue Jun 20, 2024 · 0 comments
Labels
type: enhancement Auto-labelled for feat/* and feature/* branches

Comments

@trexfeathers
Copy link
Collaborator

Something for the future - too early while the API is still in flux

There are quite a lot of parameters that appear in MANY operations, because they are needed by something deeper in the call stack. Examples include: radius/zlevel/zscale and rtol/atol. This creates a lot of bloat and duplication across the public API.

I think it would be good if we could come up with alternative solutions so that we can simplify the signatures of a lot of GeoVista operations. The solution will depend on the circumstance, but here are some examples:

  • Move more obscure tweaks into **kwargs, which could be documented in a single place
  • Contain linked arguments (e.g. rtol and atol) in a named tuple of settings
  • Activate settings using a context manager instead
  • Restructure to make greater use of classes so that the settings become class attributes
@trexfeathers trexfeathers added new: issue Highlight a new community raised "generic" issue type: enhancement Auto-labelled for feat/* and feature/* branches labels Jun 20, 2024
@bjlittle bjlittle removed the new: issue Highlight a new community raised "generic" issue label Jun 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement Auto-labelled for feat/* and feature/* branches
Projects
None yet
Development

No branches or pull requests

2 participants