Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Main documentation entry point not helpful #137

Open
uekerman opened this issue Dec 7, 2021 · 0 comments
Open

Main documentation entry point not helpful #137

uekerman opened this issue Dec 7, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@uekerman
Copy link
Member

uekerman commented Dec 7, 2021

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.

@uekerman uekerman added the documentation Improvements or additions to documentation label Dec 7, 2021
@IshaanDesai IshaanDesai self-assigned this Dec 9, 2021
@IshaanDesai IshaanDesai added this to the precice: Version 3.0.0 milestone Mar 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants