integrating documentation of command line functionality into docs

Open

#8 opened on Oct 2, 2025 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 3/5
Estimated time: 1-2 days
Newbie friendliness: 45/100

Issue type: Documentation
Clarity: Mostly clear
Activity status: Stale
Tech stack: jupyter-notebook, python
Domain: cli, documentation

Research direction

Start with the previous introduction notebook and PmagPy-cli.ipynb, then compare the command-line examples with each function's -h output. Run each function with both -h and its example, and update the documentation so the command-line functionality and its relationship to the notebook examples are clear.

Written by the indexing model from the issue text.

Description

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.

Dominant language: Jupyter Notebook
Stars: 5
Forks: 4
PR merge metrics: No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.

Similar issues

Search with selected text fails: input.value bypasses ngModel, query stays empty Open

T: Bug

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

Eugeny/tabby#11707 · Opened Sep 24, 2026
sync build ignores local_timeout when opening kv.db and scripts.db Open

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

atuinsh/atuin#4247 · 1 comment · Opened Sep 23, 2026
Fix exit code 2 when every error in a file is suppressed and anything else is reported Open

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

stylelint/stylelint#9527 · Opened Sep 23, 2026
Tailor direct-access help text and tool outputs by API root (Cloud vs self-hosted) Open

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

airbytehq/PyAirbyte#1236 · Opened Sep 23, 2026
Replace Facter APIs deprecated in OpenFact 6 (Facter::Core::Execution.exec) Open

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

simp/pupmod-simp-simp#395 · Opened Sep 23, 2026

More CLI issues