integrating documentation of command line functionality into docs
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- jupyter-notebook, python
- 領域
- cli, documentation
調査の方向性
まず以前の入門ノートブックと PmagPy-cli.ipynb から始め、次にコマンドラインの例を各関数の -h 出力と比較します。各関数を -h とその例の両方で実行し、コマンドライン機能とノートブックの例との関係が明確になるようにドキュメントを更新します。
索引モデルが 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 はありません
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
stephrobert/dsoxlab#238 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
sublimehq/package_control#1779 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
nwg-piotr/nwg-displays#145 ·
-
Bob Shell support オープンenhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100