File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1515logger = logging .getLogger (__name__ )
1616
1717def _is_model_src_exe (model_src_path : Path ):
18- #TODO add docstring
18+ """Check if input exists. Returns True if input is a file and False if it is
19+ a directory.
1920
20- #TODO add documentation links in msg below
21+ Args:
22+ model_src_path(Path): path to Stemmus_Scope executable file or to a
23+ directory containing model source codes.
24+ """
2125 if model_src_path .is_file ():
2226 msg = ("The model executable file can be used on a Unix system "
23- "where MCR is installed, see the documentaion." )
27+ "where MCR is installed, see the "
28+ "`documentaion<https://pystemmusscope.readthedocs.io/>`_." )
2429 logger .info ("%s" , msg )
2530 return True
2631 if model_src_path .is_dir ():
2732 return False
2833 msg = (
2934 "Provide a valid path to an executable file or "
3035 "to a directory containing model source codes, "
31- "see the documentaion." )
36+ "see the ` documentaion<https://pystemmusscope.readthedocs.io/>`_ ." )
3237 raise ValueError (msg )
3338
3439
@@ -37,7 +42,7 @@ def _check_interpreter(interpreter: str):
3742 msg = (
3843 "Set `interpreter` as Octave or Matlab to run the model using source codes."
3944 "Otherwise set `model_src_path` to the model executable file, "
40- "see the documentaion." )
45+ "see the ` documentaion<https://pystemmusscope.readthedocs.io/>`_ ." )
4146 raise ValueError (msg )
4247
4348
You can’t perform that action at this time.
0 commit comments