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 package #39

Merged
merged 7 commits into from
Jun 20, 2024
Merged

Refactor package #39

merged 7 commits into from
Jun 20, 2024

Conversation

Teschl
Copy link
Contributor

@Teschl Teschl commented Jun 17, 2024

I refactored the package, so the locations of different functions make more sense. The functions creating a GridObject are now in utils.py, and calling topotoolbox.GridObject() will result in an empty GridObject.

I also changed the way autosummary is used, so the way the functions are listed reflects the way they are used. Instead of having topotoolbox.utils.load_dem() in the documentation, it's now topotoolbox.load_dem() for example. The docstrings are now in the numpy format instead of the Google one, this keeps readability while insuring they are formatted right in the documentation.

closes #34

@wkearn wkearn self-requested a review June 20, 2024 07:20
Copy link
Contributor

@wkearn wkearn left a comment

Choose a reason for hiding this comment

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

Good work, @Teschl. I left one comment about some outdated documentation.

When I went to build the docs, I got some errors because my old _autosummary directory still had files from the older version. I guess make clean just cleans the _build directory. Do you know of a way to make sure that those _autosummary files also get deleted automatically? It's not a big deal, because I can always manually delete that directory. It's just a little annoying to have to remember to do that.

src/topotoolbox/grid_object.py Outdated Show resolved Hide resolved
@Teschl
Copy link
Contributor Author

Teschl commented Jun 20, 2024

@wkearn I added 'clean' to the makefile, overwriting the Sphinx version. It now cleans _build, _examples and _autosummary. After building, the _autosummary directory will get cleaned as well.

@wkearn wkearn merged commit 449d66e into TopoToolbox:main Jun 20, 2024
3 checks passed
@Teschl Teschl deleted the refactor branch June 20, 2024 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactoring of package structure
2 participants