ufs-community / ufs-mrweather-app

UFS Medium-Range Weather Application
Other
23 stars 23 forks source link

Documentation for how to set --machine still hard to find #207

Closed climbfuji closed 4 years ago

climbfuji commented 4 years ago

The latest documentation in Section 2.4 reads:

If running on a preconfigured or configurable machine, that machine will normally be recognized automatically and therefore it is not required to specify the –machine argument to create_newcase. Generic linux and macos systems will require the --machine argument to be used.

But there is no explanation how to set it / where to find this information. I believe Neil wanted to have a simple, straightforward answer right here. Users shouldn't have to search through the documentation to find this at some point later in Section 5. Either put a link in the paragraph quoted above or duplicate the information, for example

If running on a preconfigured or configurable machine, that machine will normally be recognized automatically and therefore it is not required to specify the -–machine argument to create_newcase. Generic linux and macos systems will require the --machine linux / --machine macos argument to be used. Note that in the above example I also used the correct fixed-width font type twice

Note also that in Section 5.2, last sentence, "-machine" should be --machine.

panll commented 4 years ago

Thanks, Dom! I'll change it.

ligiabernardet commented 4 years ago

This has been incorporated in documentation and merged in.