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

Require optional arguments of iodata.api functions to be specified with keywords #355

Merged
merged 1 commit into from
Jun 29, 2024

Conversation

tovrstra
Copy link
Member

@tovrstra tovrstra commented Jun 28, 2024

This fixes one of the tasks in #191, deferred from #352.

This way, scripts using IOData become more readable, lower risk of bugs. It also gives us the freedom to reorganize optional arguments with less risk of breaking API compatibility. This change is in itself API-breaking.

I will YOLO-merge this on Friday, June 5, unless reviewed earlier.

@tovrstra tovrstra added the API breaking Should be done first to stabilize API label Jun 28, 2024
@tovrstra tovrstra added this to the 1.0.0 milestone Jun 28, 2024
Copy link

deepsource-io bot commented Jun 28, 2024

Here's the code health analysis summary for commits 8cf1132..15244b2. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Shell LogoShell✅ SuccessView Check ↗
DeepSource Python LogoPython✅ SuccessView Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

Copy link
Member

@PaulWAyers PaulWAyers left a comment

Choose a reason for hiding this comment

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

LGTM

@tovrstra
Copy link
Member Author

Thanks for checking! Mergin...

@tovrstra tovrstra merged commit cedf12b into theochem:main Jun 29, 2024
12 checks passed
@tovrstra tovrstra deleted the optional-keyword branch June 29, 2024 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API breaking Should be done first to stabilize API cleanup
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants