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 panics section to the docstring of panicing functions. #25

Merged
merged 1 commit into from
Oct 14, 2024

Conversation

JSorngard
Copy link
Contributor

@JSorngard JSorngard commented Sep 26, 2024

I took the liberty of adding a # Panics section to the functions that can panic. I am not sure if I got all of them. I especially might have missed those without an assert or panic in the code, but that call other functions that can panic.

@Axect
Copy link
Owner

Axect commented Sep 27, 2024

Thank you so much for this contribution, especially given that I haven't been able to dedicate much time to Puruspe recently due to other commitments.

Upon review, it appears you've done a great job of notifying users about the basic panics. While I'll need to examine it more closely, this is undoubtedly an good start.

I think we can merge this now and continue to add notifications for any other panics we discover moving forward.

Once again, I truly appreciate your effort on this. It's a valuable addition to the project.

@JSorngard
Copy link
Contributor Author

Sounds good!

@Axect Axect merged commit 09200fe into Axect:v0.3.0 Oct 14, 2024
@JSorngard JSorngard deleted the panics branch October 14, 2024 07:03
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