Documentation for mesh_doctor (#2684)

* First shot

* Finish all the modules

* log message

* debug

* add programoutput

* Install program-output!

* Define cwd

* correct cwd

* Use command-output instead of program-output

* Improve the messages a tad

* Apply suggestions from code review

Co-authored-by: Jian Huang <[email protected]>

* Refine explaination after review comments.

Author: TotoGaz

geosx_mesh_doctor/parsing/self_intersecting_elements_parsing.py

@@ -27,7 +27,7 @@ def fill_subparser(subparsers) -> None:
                    required=False,
                    metavar=__TOLERANCE_DEFAULT,
                    default=__TOLERANCE_DEFAULT,
-                   help=f"[float]: The tolerance in the computation. Defaults to machine precision {__TOLERANCE_DEFAULT}")
+                   help=f"[float]: The tolerance in the computation. Defaults to your machine precision {__TOLERANCE_DEFAULT}.")
 
 
 def display_results(options: Options, result: Result):

geosx_mesh_doctor/parsing/supported_elements_parsing.py

@@ -34,7 +34,7 @@ def fill_subparser(subparsers) -> None:
                    required=False,
                    metavar=__NUM_PROC_DEFAULT,
                    default=__NUM_PROC_DEFAULT,
-                   help=f"[int]: Number of threads used for parallel processing. Defaults to {__NUM_PROC_DEFAULT}")
+                   help=f"[int]: Number of threads used for parallel processing. Defaults to your CPU count {__NUM_PROC_DEFAULT}.")
 
 
 def display_results(options: Options, result: Result):