Skip to content

Main documentation entry point not helpful #137

@uekerman

Description

@uekerman

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.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions