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

PR: Prepare Project for First Release Part II #3

Merged
merged 6 commits into from
Feb 3, 2025

Conversation

MichaelMauderer
Copy link
Member

@MichaelMauderer MichaelMauderer commented Jan 27, 2025

Summary

Implement further feedback from #2

Preflight

Code Style and Quality

  • Unit tests have been implemented and passed.
  • Pyright static checking has been run and passed.
  • Pre-commit hooks have been run and passed.

Documentation

  • New features are documented along with examples if relevant.
  • The documentation is Sphinx and numpydoc compliant.

@MichaelMauderer MichaelMauderer self-assigned this Jan 29, 2025
@MichaelMauderer MichaelMauderer marked this pull request as ready for review January 29, 2025 14:34
Copy link
Member

@KelSolaar KelSolaar left a comment

Choose a reason for hiding this comment

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

LGTM!

Just a minor docstring request.

"""
Return the default SOPNode instance. Contains the default values that
should be used per specification in case the actual value is not provided.
"""
Copy link
Member

Choose a reason for hiding this comment

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

Would it be please possible to add the Returns docstring section?

Returns
--------
...

Same for the others, after this we are gold! Cheers.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done!

@KelSolaar
Copy link
Member

Ship it!

@MichaelMauderer MichaelMauderer merged commit 2b3ccee into develop Feb 3, 2025
29 checks passed
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