You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? If so, please describe.
If one interactively uses openpmd-api in python e.g. via ipython or jupyter, one might need to look up the usage via reading the docstrings as e.g. below
Describe the solution you'd like
It would be fantastic if one could have a more readably docstring for the openPMD-api python module.
Describe alternatives you've considered
Currently the best way (for me) is to follow the examples.
Additional context
This is not urgent, but it would enhance productivity if one does not have to look for the right example or to scroll through the source code to figure out how to use the python version.
The text was updated successfully, but these errors were encountered:
That's a great point and was a bit undervalued for the initial binding implementation.
One can add to a pybind binding multiple optional arguments with a raw string (body) and py::arg("name") for positional function parameters, including an = ... assignment for their default values.
Is your feature request related to a problem? If so, please describe.
If one interactively uses openpmd-api in python e.g. via ipython or jupyter, one might need to look up the usage via reading the docstrings as e.g. below
Python:
results in a less-user-friendly output
Describe the solution you'd like
It would be fantastic if one could have a more readably docstring for the openPMD-api python module.
Describe alternatives you've considered
Currently the best way (for me) is to follow the examples.
Additional context
This is not urgent, but it would enhance productivity if one does not have to look for the right example or to scroll through the source code to figure out how to use the python version.
The text was updated successfully, but these errors were encountered: