Skip to content

Fix examples in docstrings in cli.py #1716

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 3, 2017
Merged

Fix examples in docstrings in cli.py #1716

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions nipype/scripts/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ def search(logdir, regex):
a given regular expression.

Examples:\n
nipype search nipype/wd/log -r '.*subject123.*'
nipypecli search nipype/wd/log -r '.*subject123.*'
"""
from .crash_files import iter_tracebacks

Expand Down Expand Up @@ -61,8 +61,8 @@ def crash(crashfile, rerun, debug, ipydebug, dir):
For certain crash files, one can rerun a failed node in a temp directory.

Examples:\n
nipype crash crashfile.pklz\n
nipype crash crashfile.pklz -r -i\n
nipypecli crash crashfile.pklz\n
nipypecli crash crashfile.pklz -r -i\n
"""
from .crash_files import display_crash_file

Expand All @@ -82,7 +82,7 @@ def show(pklz_file):
"""Print the content of Nipype node .pklz file.

Examples:\n
nipype show node.pklz
nipypecli show node.pklz
"""
from pprint import pprint
from ..utils.filemanip import loadpkl
Expand All @@ -104,8 +104,8 @@ def run(ctx, module, interface, list, help):
"""Run a Nipype Interface.

Examples:\n
nipype run nipype.interfaces.nipy --list\n
nipype run nipype.interfaces.nipy ComputeMask --help
nipypecli run nipype.interfaces.nipy --list\n
nipypecli run nipype.interfaces.nipy ComputeMask --help
"""
import argparse
from .utils import add_args_options
Expand Down