integrating documentation of command line functionality into docs
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 45/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- jupyter-notebook, python
- Lĩnh vực
- cli, documentation
Hướng nghiên cứu
Bắt đầu với notebook giới thiệu trước đó và PmagPy-cli.ipynb, sau đó so sánh các ví dụ dòng lệnh với đầu ra -h của từng hàm. Chạy từng hàm với cả -h và ví dụ của hàm đó, rồi cập nhật tài liệu để làm rõ chức năng dòng lệnh và mối quan hệ của chức năng này với các ví dụ trong notebook.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
The previous version of the introduction notebook started with describing the command line functionality. An issue with this notebook for documenting the command line is that it doesn't include the descriptions that can be found by using the -h flag. We could run each function with both the -h flag and then the example. Note that this programs have functional equivalents now that we could decide largely supersede the command line programs at some point.
This text:
PmagPy is a software package for analyzing paleomagnetic and rock magnetic data using Python. These notebooks demonstrate how to use PmagPy in a Jupyter notebook or Python script. For examples of how to use PmagPy scripts on the command line, see the static version of PmagPy_cli. If you are running this notebook locally, you can click the following link to launch PmagPy-cli.ipynb
has been simplified to:
PmagPy is a software package for analyzing paleomagnetic and rock magnetic data using Python. These notebooks demonstrate how to use PmagPy in a Jupyter notebook. These examples can be adapted into Python scripts.
to try and keep things more straight forward for a new user.
The text
For examples of how to use PmagPy scripts on the command line, see the static version of PmagPy_cli.
could be added later.
- Ngôn ngữ chính
- Jupyter Notebook
- Star
- 5
- Fork
- 4
- 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 PmagPy/PmagPy-docs
-
SVEI notebook link not active Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
PmagPy/PmagPy-docs#15 ·
-
documentation
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
PmagPy/PmagPy-docs#13 · 12 bình luận ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
PmagPy/PmagPy-docs#4 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 42/100
PmagPy/PmagPy-docs#2 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 48/100
PmagPy/PmagPy-docs#1 ·
Tất cả issue của PmagPy/PmagPy-docs
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
vercel-labs/just-bash#464 ·
-
looksLikeSlug() is ASCII-only, so non-Latin entity slugs (e.g. Korean) skip exact match and collapse Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
-
bug
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
vercel-labs/skills#2291 ·
-
setup tools wizard offers no GitHub auth path, and setup summary doesn't recognize `gh` CLI auth Đang mởarea/auth comp/cli P3 tool/skills type/bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
NousResearch/hermes-agent#121131 ·