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

Update docs to fix Doxygen build warnings #56

Merged
merged 3 commits into from
Aug 5, 2024
Merged

Conversation

oruebel
Copy link
Contributor

@oruebel oruebel commented Aug 2, 2024

Fix #50

Update docstrings to fix warnings in Doxygen build

@oruebel oruebel requested a review from stephprince August 2, 2024 07:24
Copy link
Collaborator

@stephprince stephprince left a comment

Choose a reason for hiding this comment

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

Thanks for fixing those, looks good.

I'm wondering if we want to change the doxygen warnings to be errors so that the build will fail if the docstrings don't match the functions?

@oruebel
Copy link
Contributor Author

oruebel commented Aug 5, 2024

I'm wondering if we want to change the doxygen warnings to be errors so that the build will fail if the docstrings don't match the functions?

I'd suggest we add a GitHub action to simply test whether the docs are building. This would be similar to the action for deploying the docs on GitHub Pages, but with warnings elevated to errors and without actually deploying the docs. IN this way we'll see the errors on every PR.

@oruebel oruebel merged commit 611ebee into main Aug 5, 2024
7 checks passed
@oruebel oruebel deleted the fix_docs_warnings branch August 5, 2024 15:48
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.

Fix warnings and errors in docs build
2 participants