Main documentation entry point not helpful
@IshaanDesai đang làm issue này rồi.
Từ ngày 9/12/2021.
Đánh giá
Issue này chưa được đánh giá.
Mô tả
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.
- Ngôn ngữ chính
- Cython
- Star
- 30
- Fork
- 19
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của precice/python-bindings
-
documentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
precice/python-bindings#258 · 1 reaction ·
-
enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
precice/python-bindings#175 · 2 bình luận ·
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 20/100
precice/python-bindings#255 ·
-
good first issue
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 68/100
precice/python-bindings#248 ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 38/100
precice/python-bindings#238 · 6 bình luận ·