Skip to content

Commit

Permalink
minor edit docs command line capital C when needed
Browse files Browse the repository at this point in the history
  • Loading branch information
juangpc authored and LorenzE committed Jul 7, 2020
1 parent a847193 commit b67b0a3
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion applications/mne_anonymize/settingscontrollercl.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ void SettingsControllerCl::initParser()
m_parser.addHelpOption();

//this breaks encapsulation. damn it. it has to be here in order to show in the help text.
QCommandLineOption commandLineOpt("no-gui",QCoreApplication::translate("main","command line version of this application."));
QCommandLineOption commandLineOpt("no-gui",QCoreApplication::translate("main","Command line version of this application."));
m_parser.addOption(commandLineOpt);

QCommandLineOption versionOpt("version",QCoreApplication::translate("main","Show the version of this application."));
Expand Down
2 changes: 1 addition & 1 deletion doc/gh-pages/pages/learn/dipolefit.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ nav_order: 4
---
# MNE Dipole Fit CLI

## command line options
## Command line options

`mne_dipole_fit` recognizes the following command line options:

Expand Down
2 changes: 1 addition & 1 deletion doc/gh-pages/pages/learn/fwdsolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ nav_order: 5
---
# MNE Forward Solution CLI

## command line options
## Command line options

`mne_forward_solution` recognizes the following command line options:

Expand Down
6 changes: 3 additions & 3 deletions doc/gh-pages/pages/learn/mneanonymize.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,16 +57,16 @@ MNE Anonymize does not modify the input file. Moreover, this application can eve

MNE Anonymize binary file is named `mne_anonymize`. By default, the application is executed in GUI mode. However, if you want to run `mne_anonymize` in GUI mode but you still want to initialize some of the options through a command line call, you can allways do so through the actual command prompt. For example, if you execute `mne_anonymize --in example.fif -bdf` the GUI will start and the options in it will be already set accordingly. The application recognizes several command line options, see bellow.

## command line Mode
## Command line Mode

MNE Anonymize can also be executed in command line mode. This is intended for users that might want to anonymize a considerable number of files. The following table shows all valid command line options.

### command line Options
### Command line Options

| Option | Description |
|--------|-------------|
|`-h --help`| Displays help on the command line.|
|`--no-gui`| command line version of the application.|
|`--no-gui`| Command line version of the application.|
|`--version`| Show the version of this appliation.|
|`-i --in <infile>`| File to anonymize.|
|`-o --out <outfile>` *optional*| Output file `<outfile>`. As default '_anonymized.fif' is attached to the file name.|
Expand Down

0 comments on commit b67b0a3

Please sign in to comment.