Menu

#2 documentation completely missing

open
nobody
None
9
2010-03-08
2010-02-18
No

No documentation has been added to the code. Suggestions:

-use docstrings extensively
-create README and/or INSTALL files in the main directory
-use doxygen to generate documentation from the code (API) in HTML format, which will provide you the description of the classes and their attributes

Discussion

  • Jordi Villà-Freixa

    • priority: 5 --> 9
     
  • Jordi Villà-Freixa

    no Doxyfile, no README, no INSTALL available.
    Information about dependencies also missing in the main directory (MMTK? BioPython?)

     
  • Jordi Villà-Freixa

    still incomplete documentation. A README file is needed in the main directory explaining hoy to run the program, what are its dependencies (MMTK, ...) and what are the files to modify with the user configuration. This should also include an example on how to add a new python path for the program not to complain (for example, not finding MMTK)

     

Log in to post a comment.