integrating documentation of command line functionality into docs
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 45/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- jupyter-notebook, python
- 领域
- cli, documentation
调研方向
先从之前的入门 notebook 和 PmagPy-cli.ipynb 开始，然后将命令行示例与每个函数的 -h 输出进行比较。使用 -h 和该函数的示例分别运行每个函数，并更新文档，以明确命令行功能及其与 notebook 示例的关系。
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- Jupyter Notebook
- 星标
- 5
- 派生
- 4
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
我们还没有检查这个项目的环境配置文件。先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
PmagPy/PmagPy-docs 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 62/100
PmagPy/PmagPy-docs#15 ·
-
documentation
难度 3/5 1-2 天 新手友好度 35/100
PmagPy/PmagPy-docs#13 · 12 条评论 ·
-
难度 3/5 1-2 天 新手友好度 35/100
PmagPy/PmagPy-docs#4 ·
-
难度 2/5 1-3 小时 新手友好度 42/100
PmagPy/PmagPy-docs#2 ·
-
难度 2/5 1-3 小时 新手友好度 48/100
PmagPy/PmagPy-docs#1 ·
查看 PmagPy/PmagPy-docs 的全部 Issue
相似的 Issue
-
`categorize_command` has no `uv` arm, so every `rtk uv …` row counts as `other` in the ecosystem mix未关闭area:api bug good first issue priority:low
难度 1/5 1 小时以内 新手友好度 92/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 92/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 84/100
Tencent/teamai-cli#862 ·
维护者通常 1 天内回复
-
area/cli kind/bug
难度 2/5 1-3 小时 新手友好度 90/100
维护者通常 1 天内回复
-
bug needs triage
难度 2/5 1-3 小时 新手友好度 78/100
netdata/netdata#24062 · 1 条评论 ·
维护者通常 1 天内回复