Skip to content

Future_of_M2___Infrastructure_Göttingen2011

Mahrud Sayrafi edited this page Mar 12, 2021 · 1 revision

title: Future of M2 / Infrastructure Göttingen2011 permalink: wiki/Future_of_M2_/_Infrastructure_Göttingen2011/ layout: wiki

  • More details on options of functions and examples.
  • Better standards on documentation.
  • More formal mentoring?
  • Fill out evaluation!
  • Check code coverage.
  • Tagging documentation for better keyword search.
  • Syntax highlighting in the examples of the html documentation.
    • to get the example type examples
    • Ex.: examples matrix
    • But clicking around don't have this - Want a link on the html page to give the example code so you can cut and paste + experiment.
  • Typo on doc page - nice if can click on it + have it take you right there. Requires browser to talk to emacs... (maybe...)
  • Fix 5 documentation nodes - not in your expertise.
  • Internal comments for functions. Needs examples/suggestions.
    • Example: Complicated mathematical formulas - where did it come from?
    • Give hint where formula came from: This is algorithm from such and such; give link... (Ex.: In Fulton at ...)
    • SimpleDoc node heading for references.
    • Internally (at least!) document the method used and any difficulties!
    • Make sure you document (carefully) internally all functions not exported!
  • Use svn merge to move files to trunk (if you have the writepermissions) Otherwise
    • Give package to Dan for trunk.
    • When ready for distribution tell Dan - It won't get distributed if you don't say it should be.
Clone this wiki locally