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

Fix warnings in the documentation build #360

Merged
merged 19 commits into from
Dec 4, 2024

Conversation

akeeste
Copy link
Contributor

@akeeste akeeste commented Nov 21, 2024

This PR pairs with MHKiT-Software/MHKiT#80 and aims to eliminate the volume of warnings occurring in our documentation build.

Many of these changes will probably be fixing minor spacings/lines/issues in docstrings that show up as warnings but not errors when the documentation builds. Future linting should address and prevent these issues too.

@akeeste akeeste mentioned this pull request Nov 21, 2024
@akeeste
Copy link
Contributor Author

akeeste commented Nov 21, 2024

@ssolson this should be a low lift to review when ready. We don't need to delay our release for this PR, but it would be great to merge whatever is pushed here and ready before the release. This will help ease future documentation updates and keep it fully updated.

@ssolson ssolson added the Clean Up Improve code consistency and readability label Nov 27, 2024
@ssolson ssolson self-requested a review November 27, 2024 21:33
@akeeste akeeste marked this pull request as ready for review December 2, 2024 18:08
@akeeste
Copy link
Contributor Author

akeeste commented Dec 3, 2024

@ssolson I pushed a couple final commits to also resolve #355 as the pacwave notebook was resulting in an incorrect plot in the documentation.

Copy link
Contributor

@ssolson ssolson left a comment

Choose a reason for hiding this comment

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

Thanks @akeeste this PR focuses on clean up of the code.

@ssolson ssolson merged commit 96dc8b4 into MHKiT-Software:develop Dec 4, 2024
43 checks passed
@ssolson ssolson mentioned this pull request Dec 4, 2024
@akeeste akeeste linked an issue Dec 4, 2024 that may be closed by this pull request
@akeeste akeeste deleted the fix_doc_warnings branch January 14, 2025 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Clean Up Improve code consistency and readability
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PacWave clusters plot has flipped axes labels
2 participants