API: Decide on keyword only API - #2832
Merged
Merged
Conversation
Contributor
Author
|
(I still need to update the test suite and the docs, but that is quite straightforward) EDIT: Done |
erikvansebille
approved these changes
Aug 17, 2026
erikvansebille
left a comment
Member
There was a problem hiding this comment.
Yep I agree with this list. PR looks good
VeckoTheGecko
enabled auto-merge (squash)
August 17, 2026 10:37
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
I was looking through the tutorial to see how we're using our functions, and to decide on which API should be keyword only. These are my thoughts
parcels.FieldSet.from_sgrid_conventionsmesh,vector_fields,skip_field_data_validationkeyword onlyparcels.FieldSet.from_ugrid_conventionsmesh,vector_fieldskeyword onlyparcels.ParticleSet.__init__ParticleFile.__init__This is a bit subjective. Happy to discuss if you have other thoughts @erikvansebille
Checklist
mainfor normal development,v3-supportfor v3 support)AI Disclosure
None used