Skip to content

Commit db4fbc9

Browse files
committed
Add --version flag to the documentation
1 parent 8cdbc4a commit db4fbc9

2 files changed

Lines changed: 13 additions & 1 deletion

File tree

docs/source/changelog.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ New features
1515
* Allow a founding individual to have two different metafounders, e.g., one for the paternal lineage and one for the maternal lineage
1616
(:pr:`222`, :user:`RosCraddock`, :user:`gregorgorjanc`, :user:`XingerTang`).
1717

18+
* Add a version option to the command line interface
19+
(:pr:`237`, :user:`XingerTang`).
20+
1821
Maintenance
1922
-----------
2023

@@ -34,6 +37,11 @@ Maintenance
3437
* Updated the documentation to clarify inputs, outputs, and parameters
3538
(:pr:`219`, :user:`gregorgorjanc`).
3639

40+
* Add collaboration guidelines to the documentation
41+
(:pr:`224`, :user:`XingerTang`, :user:`RosCraddock`, :user:`AprilYuZhang`, :user:`gregorgorjanc`).
42+
43+
* Updated the documentation to add more techincal instructions for developers and contributors
44+
(:pr:`237`, :user:`XingerTang`).
3745

3846
[1.3.0] - 2026-02-05
3947
====================

docs/source/usage.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ Program options
1212

1313
|Software| accepts several command-line options to control the program's behaviour.
1414
To view a list of all supported options, run |Software| like this:
15-
``AlphaPeel`` or ``AlphaPeel -h``.
15+
``AlphaPeel``, ``AlphaPeel -h`` or ``AlphaPeel --help``.
16+
17+
User can check the version of the program with ``AlphaPeel --version``.
18+
Remember to use the correct version of the documentation for the version of the program you are using.
19+
For example, the link to the documentation for version ``1.3.0`` is https://alphapeel.readthedocs.io/en/1.3.0/index.html.
1620

1721
.. _input_options:
1822

0 commit comments

Comments
 (0)