DOC: Improve documentation of --nprocs and --omp-nthreads
#986
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
effigies
reviewed
Apr 27, 2022
mriqc/cli/parser.py
Outdated
| 8-CPU-threaded processes will be running at a given time). | ||
| Under this mode of operation, ``--nprocs`` sets the maximum number of processors | ||
| that can be assigned work within an *MRIQC* job, which includes all the processors | ||
| used by currently running single- and multi-threaded processes.""", |
There was a problem hiding this comment.
Does this look okay in --help? It seems like a lot of text including markup.
There was a problem hiding this comment.
The markup is for sphinx-argparse - that gets rendered in https://mriqc.readthedocs.io/en/latest/running.html#command-line-interface.
I'm not particularly annoyed by this level of markup within the shell, if we can agree on that, I guess this is a thumb-up?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If this is accepted, we should probably propagate it to fMRIPrep.
Resolves: #849.