Commit 6306fd99 authored by VIGNET Pierre's avatar VIGNET Pierre
Browse files

[cmd] Fix typos in docstrings

parent 81527c2d
......@@ -38,6 +38,7 @@ LOGGER = cm.logger()
def check_output_dir(function):
"""Decorator used process some arguments from argparse"""
# Expose the docstring of the wrapped function instead of that of the decorator
@wraps(function)
def modified_func(*args, **kwargs):
"""Fix paths in arguments (add trailing '/')"""
......@@ -79,7 +80,7 @@ def solutions_sort(args):
@check_output_dir
def solutions_2_graphs(args):
"""Create GraphML formated files containing a representation of the
trajectories for every solution in complete MAC files (*mac_complete files).
trajectories for each solution in complete MAC files (*mac_complete files).
This is a function to visualize paths taken by the solver from the boundaries
to the entities of interest.
......@@ -135,8 +136,9 @@ def json_2_interaction_graph(args):
@check_output_dir
def solutions_2_common_graph(args):
"""Create a GraphML formated file containing a representation of **all**
trajectories for **all** solutions in complete MAC files (*mac_complete files).
"""Create a GraphML formated file containing a unique representation of **all**
trajectories corresponding to all solutions in each complete MAC files
(*mac_complete files).
This is a function to visualize paths taken by the solver from the boundaries
to the entities of interest.
......
......@@ -226,7 +226,7 @@ def solutions_2_graphs(output_dir, model_file, path):
"""Entry point for solutions_2_graphs
Create GraphML formated files containing a representation of the
trajectories for every solution in complete MAC files (\*mac_complete files).
trajectories for each solution in complete MAC files (\*mac_complete files).
This is a function to visualize paths taken by the solver from the boundaries
to the entities of interest.
......@@ -321,8 +321,9 @@ def convert_solution_file_to_graphs(output_dir, sol_steps, transitions):
def solutions_2_common_graph(output_dir, model_file, path):
"""Entry point for solutions_2_common_graph
Create a GraphML formated file containing a representation of **all**
trajectories for **all** solutions in complete MAC files (\*mac_complete files).
Create a GraphML formated file containing a unique representation of **all**
trajectories corresponding to all solutions in each complete MAC files
(*mac_complete files).
This is a function to visualize paths taken by the solver from the boundaries
to the entities of interest.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment