Cleaup Component Help for TorchX and add message for xlformers

Differential Revision: D55401844

Pull Request resolved: #860

Author: andywag

torchx/specs/file_linter.py

@@ -31,7 +31,11 @@ def _get_default_arguments_descriptions(fn: Callable[..., object]) -> Dict[str,
     return args_decs
 
 
-class TorchXArgumentHelpFormatter(argparse.HelpFormatter):
+class TorchXArgumentHelpFormatter(
+    argparse.RawDescriptionHelpFormatter,
+    argparse.ArgumentDefaultsHelpFormatter,
+    argparse.MetavarTypeHelpFormatter,
+):
     """Help message formatter which adds default values and required to argument help.
 
     If the argument is required, the class appends `(required)` at the end of the help message.
@@ -81,7 +85,7 @@ def get_fn_docstring(fn: Callable[..., object]) -> Tuple[str, Dict[str, str]]:
             args_description[param.arg_name] = param.description
     short_func_description = docstring.short_description or default_fn_desc
     if docstring.long_description:
-        short_func_description += " ..."
+        short_func_description += "\n" + docstring.long_description
     return (short_func_description or default_fn_desc, args_description)
 
 

torchx/specs/test/file_linter_test.py

@@ -193,7 +193,7 @@ def test_validate_args_no_type_defs_complex(self) -> None:
 
     def test_validate_docstring(self) -> None:
         func_desc, param_desc = get_fn_docstring(_test_docstring)
-        self.assertEqual("Short Test description ...", func_desc)
+        self.assertEqual("Short Test description\nLong funct description", func_desc)
         self.assertEqual("arg0 desc", param_desc["arg0"])
         self.assertEqual("arg1 desc", param_desc["arg1"])
         self.assertEqual(" ", param_desc["arg2"])