lib_task_docs
_get_function_description(package_name, module_path, function_name)
¶
Extract function description from its docstring.
PARAMETER | DESCRIPTION |
---|---|
package_name |
Example
TYPE:
|
module_path |
Example
TYPE:
|
function_name |
Example
TYPE:
|
Source code in fractal_tasks_core/dev/lib_task_docs.py
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
|
create_docs_info(executable_non_parallel=None, executable_parallel=None, package='fractal_tasks_core')
¶
Return task description based on function docstring.
Source code in fractal_tasks_core/dev/lib_task_docs.py
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
|
read_docs_info_from_file(*, docs_info, task_list_path)
¶
Return task description based on the content of a file.
An example of valid argument is
docs_info = "file:relative/path/info.md"
task_list.py
is.
Source code in fractal_tasks_core/dev/lib_task_docs.py
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
|