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

Add docstrings to all classes and functions #20

Merged
merged 3 commits into from
Aug 22, 2023
Merged

Add docstrings to all classes and functions #20

merged 3 commits into from
Aug 22, 2023

Conversation

AdamJCrawford
Copy link
Member

There is still some work needed on this, but this lays out the groundwork.

@AdamJCrawford AdamJCrawford requested a review from nickrsan August 17, 2023 17:14
@nickrsan
Copy link
Contributor

I forgot that this was outstanding and made a bunch of changes today that fix numerous bugs. I'm going to commit/merge those to release, then deconflict this one, which shouldn't be too bad.

Copy link
Contributor

@nickrsan nickrsan left a comment

Choose a reason for hiding this comment

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

Looks like useful work - as noted, we'll continue on improving the docstrings, but these get us started. Thanks Adam

@nickrsan
Copy link
Contributor

I'm going to merge this now and know that a few fixes need to be made to some code (examples) based on changing filename_prefix to filename_suffix and the change to last_task_status. Since we're not yet released, I'll make the changes directly on release branch after this.

@nickrsan nickrsan merged commit e2a578c into water3d:release Aug 22, 2023
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.

2 participants