Skip to content

Commit 0e01cdf

Browse files
authored
Merge pull request #271 from CCPBioSim/270-docs-improve-getting-started-documentation
Improve Getting Started documentation clarity and workflow
2 parents 0418f8b + 043ea25 commit 0e01cdf

File tree

3 files changed

+201
-84
lines changed

3 files changed

+201
-84
lines changed

CodeEntropy/config/arg_config_manager.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,12 @@
6868
"action": "store_true",
6969
"help": "Enable verbose output",
7070
},
71-
"thread": {"type": int, "help": "How many multiprocess to use", "default": 1},
7271
"output_file": {
7372
"type": str,
74-
"help": "Name of the file where the output will be written",
73+
"help": (
74+
"Name of the output file to write results to (filename only). Defaults "
75+
"to output_file.json"
76+
),
7577
"default": "output_file.json",
7678
},
7779
"force_partitioning": {"type": float, "help": "Force partitioning", "default": 0.5},

docs/developer_guide.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ Edit docs in the following directories:
9898

9999
Contributing Code
100100
-----------------
101+
If you would to contribution to **CodeEntropy** please refer to our `Contributing Guidelines <https://github.com/CCPBioSim/CodeEntropy?tab=contributing-ov-file>`_
101102

102103
Creating an Issue
103104
^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)