Main documentation entry point not helpful
@IshaanDesai ci sta già lavorando.
Dal 9/12/2021.
Valutazione
Questa issue non è ancora stata valutata.
Descrizione
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.
- Lingua principale
- Cython
- Stelle
- 30
- Fork
- 19
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di precice/python-bindings
-
documentation
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
precice/python-bindings#258 · 1 reazione ·
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
precice/python-bindings#175 · 2 commenti ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 20/100
precice/python-bindings#255 ·
-
good first issue
Difficoltà 3/5 1-2 giorni Idoneità per principianti 68/100
precice/python-bindings#248 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 38/100
precice/python-bindings#238 · 6 commenti ·