precice / precice/python-bindings
Main documentation entry point not helpful
Open
@IshaanDesai is already working on this.
Since Dec 9, 2021.
documentation
- Dominant language
- Cython
- Stars
- 30
- Forks
- 19
- PR merge metrics
- No merged PRs in 30d
Description
When typing
>>> import precice
>>> help(precice)
you get:
NAME
precice
PACKAGE CONTENTS
_version
FUNCTIONS
action_read_iteration_checkpoint(...)
Returns
-------
Name of action for reading iteration checkpoint
action_write_initial_data(...)
Returns
-------
Name of action for writing initial data
action_write_iteration_checkpoint(...)
Returns
-------
Name of action for writing iteration checkpoint
get_version_information(...)
Returns
-------
Current preCICE version information
VERSION
v2.2.0.1
FILE
/home/uekermbn/.local/lib/python3.8/site-packages/precice/__init__.py
It would be helpful to link/mention the Ìnterface object here and that help(precice.Interface) gives more information.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.