Commit 6483abb9 authored by VIGNET Pierre's avatar VIGNET Pierre
Browse files

Update module documentation: list of functions

parent bbc6e04a
......@@ -28,6 +28,22 @@ of the files generated by the solver of Cadbiom.
Here we find high-level functions to parse or clean *cam* files, and extract
all their data to a JSON format, a data interchange format that is humanly
readable and useful in programming.
Generic functions
~~~~~~~~~~~~~~~~~
* :meth:`~cadbiom_cmd.tools.solutions.get_query_from_filename`
Handle \*cam_complete.txt files
-------------------------------
* :meth:`~cadbiom_cmd.tools.solutions.load_solutions`
* :meth:`~cadbiom_cmd.tools.solutions.convert_solutions_to_json`
Handle \*cam\* files
--------------------
* :meth:`~cadbiom_cmd.tools.solutions.get_solutions`
* :meth:`~cadbiom_cmd.tools.solutions.get_cam_lines`
* :meth:`~cadbiom_cmd.tools.solutions.get_all_cams`
"""
from __future__ import unicode_literals
from __future__ import print_function
......
Supports Markdown
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