Modify docstrings to clearly state the flexibility of the API in accepting multidimensional data structures #239
Conversation
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
…pting multidimensional data structures
MakisH
approved these changes
Jun 16, 2025
Member
MakisH
left a comment
MakisH
left a comment
There was a problem hiding this comment.
This definitely helps.
The individual changes/examples make sense.
What about the map_and_read_data, which triggered the discussion? It also needs an example.
I have not checked if anything else needs a similar example, but since set_mesh_vertices is the first one to call, it would be kind of expected that the same applies to all.
Member
Author
I'll add an example here only. |
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.
From the discussion in #236, it emerged that there is confusion about the acceptable ways to provide multidimensional data structures to the API. The examples in the docstrings primarily show that NumPy arrays can be used, but the API also accepts a list of lists, or a list of tuples. This PR modifies the docstrings to clearly state this flexibility of the API.