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

Basic GridObject and .info() function #11

Merged
merged 15 commits into from
Apr 18, 2024
Merged

Conversation

Teschl
Copy link
Contributor

@Teschl Teschl commented Apr 10, 2024

I also removed the examples/ from .gitignore

@wkearn
Copy link
Contributor

wkearn commented Apr 10, 2024

This looks good. We'll probably want to address @wschwanghart's comments on #6 at some point, but if we need to make changes based on those comments, it shouldn't be too hard at this point to add things to the current version of GridObject.

The one thing we probably should figure out now is the name: GridObject as we have it here or GRIDobj like the MATLAB version or something else? I assume that the argument for GridObject is that it sounds more like other Python classes, right? Why not drop the Object and call it Grid?

@Teschl
Copy link
Contributor Author

Teschl commented Apr 10, 2024

Anna-Lena always preferred the GridObject variant to GRIDobj since it's the "pythonic" variant as specified in PEP 8.

We could also add aliases in the __init__.py file. That way, GridObject, Grid or GRIDobj would all work, and the user can pick whichever they like best.

@wkearn wkearn merged commit bfb46c1 into TopoToolbox:main Apr 18, 2024
@Teschl Teschl deleted the GridObject branch April 20, 2024 13:18
@wkearn wkearn added the enhancement New feature or request label May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants