precice / precice/python-bindings

Main documentation entry point not helpful

Aperta
#137 0 commenti 0 reazioni 1 assegnatario Vedi su GitHub

@IshaanDesai ci sta già lavorando.

Dal 9/12/2021.

documentation
Lingua principale
Cython
Stelle
30
Fork
19
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

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.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.