Update of documentation for #4223#4241
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4241 +/- ##
==========================================
- Coverage 51.40% 50.23% -1.18%
==========================================
Files 151 151
Lines 30055 29365 -690
==========================================
- Hits 15451 14752 -699
- Misses 14604 14613 +9 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| process | ||
| ``` | ||
| In this case the output files will be `OUT.DAT` and `MFILE.DAT`. | ||
| PROCESS input file names end in IN.DAT. If no input file name is given as an argument in the command line, PROCESS will run `process --help`. |
There was a problem hiding this comment.
These sentences aren't needed any more
There was a problem hiding this comment.
Not sure why these aren't needed? It explains they need to end in IN.DAT and if you run with no input file it prints the help message.
There was a problem hiding this comment.
Sorry worded this badly as I gave no explanation! The bit about ending in IN.DAT is already below (on line 21), and then the bit about process giving the help menu can be moved down to join the bit already on line 70, so all this information will stay here, just rearranged a tad. I think referencing 'running without an input file' isn't as clear as instead saying running process will give the help message
| In this case the output files will be `OUT.DAT` and `MFILE.DAT`. | ||
| PROCESS input file names end in IN.DAT. If no input file name is given as an argument in the command line, PROCESS will run `process --help`. | ||
|
|
||
| The `examples/data` folder in the repository has the commonly used `large_tokamak_IN.DAT` input file, which can be a useful starting point for new users. |
There was a problem hiding this comment.
This can be moved further down (see later comment), so this section can begin with 'The user can provide a named input file...'

Description
Minor change to documentation pages to reflect:
IN.DATandIN.DAT, it will runprocess --help.Checklist
I confirm that I have completed the following checks: