Main documentation entry point not helpful
@IshaanDesai ya está trabajando en esto.
Desde el 9/12/2021.
Evaluación
Este issue todavía no se ha evaluado.
Descripción
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.
- Lenguaje dominante
- Cython
- Estrellas
- 30
- Forks
- 19
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de precice/python-bindings
-
documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
precice/python-bindings#258 · 1 reacción ·
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
precice/python-bindings#175 · 2 comentarios ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
precice/python-bindings#255 ·
-
good first issue
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
precice/python-bindings#248 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 38/100
precice/python-bindings#238 · 6 comentarios ·