Commit f1ce1dd5 authored by VIGNET Pierre's avatar VIGNET Pierre
Browse files

Fix typos update doc

parent 7f790db7
......@@ -47,7 +47,7 @@ def launch_researchs(args):
def launch_sort(args):
"""Read a solution file or a directory containing solution files
"""Read a solution file or a directory containing MAC solutions files
(*cam* files), and sort all frontier places/boundaries in alphabetical order.
"""
......
......@@ -378,7 +378,9 @@ def graph_isomorph_test(model_file_1, model_file_2, output_dir='graphs/',
def low_graph_info(model_file, centralities):
"""Low level function for model_graph(); Get objects with info and graph.
"""Low level function for :meth:`~cadbiom_cmd.solution_repr.model_graph`.
Get JSON data with information about the graph based on the model.
:param arg1: File for the model.
:param arg2: If True with, compute centralities
......@@ -484,7 +486,9 @@ def low_graph_info(model_file, centralities):
def low_model_info(model_file,
all_entities=False, boundaries=False, genes=False):
"""Low level function for model_info(); Get dict with info about places.
"""Low level function for :meth:`~cadbiom_cmd.solution_repr.model_info`.
Get JSON data with information about the model and its entities.
:param arg1: File for the model.
:param arg2: If True, data for all places of the model are returned
......
......@@ -87,6 +87,8 @@ def sort_solutions(path):
Read a solution(s) file(s) (*cam* files) and sort all
frontier places/boundaries in alphabetical order.
This functions tests if the given path is a directory or a file.
.. warning:: The files will be modified in place.
:param: Filepath or directory path containing Cadbiom solutions.
......
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