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% 51.38% -0.03%
==========================================
Files 151 151
Lines 30055 30039 -16
==========================================
- Hits 15451 15435 -16
Misses 14604 14604 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| will produce the following output files in the same directory as the input file: | ||
|
|
||
| ``` | ||
| my_file_name_OUT.DAT |
There was a problem hiding this comment.
While you're here, could you update this list of output files please as this is no longer correct, eg here are the outputs I got from running examples/data/large_tokamak_IN.DAT with --full-output:
| 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
| 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...'
| ``` | ||
|
|
||
| --------------- | ||
|
|
There was a problem hiding this comment.
Can you move the sentence about the examples/data dir from above to here please
| ```bash | ||
| process --help | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Could you add here 'or with process' please in the same bash formatting as the line above?
| will produce the following output files in the same directory as the input file: | ||
| ``` | ||
| my_file_name_OUT.DAT | ||
| my_file_name_MFILE.DAT |
There was a problem hiding this comment.
While you're here, could you also add the SIG_TF.json and _process.log files here too please?
3 participants
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: