Add files

core/doc/b2_review_CODE_NAME.tex

@@ -0,0 +1,160 @@
+\documentclass{article}
+
+\usepackage{amssymb,amsmath}
+
+\oddsidemargin 0.0in
+\textwidth 6.5in
+\headheight -0.5in
+\topmargin 0.5in
+\headsep 0.0in
+\textheight 9.2in
+\parskip 3mm
+\pagestyle{empty}
+
+
+%%%%%%%%%%%%%%%%%%%
+%%%%% INSTRUCTIONS %%%%%
+%%%%%%%%%%%%%%%%%%%
+
+% REVIEWER:  Please fill out the following fields.  The form will then be filled in automatically upon compilation.
+% The goal of this review is to determine whether the code under review is adequate for inclusion into the develop branch of b2.
+% If you have any hesitations on any yes/no question, mark no and explain your concerns.
+% Please work with the author(s) of the code under review to resolve any issues.
+% A final copy of all reviews must be submitted to Dan Bates before the pull request for the code under review is accepted.
+% Copies of the final review forms will be kept in the repo for future reference.
+%
+% If you have questions, please contact Dan Bates.
+
+
+\newcommand\you{  Dan Bates, bates@math.colostate.edu  }  %your name, email
+\newcommand\class{  Example Class  }  %name of the class, file, or module you are reviewing
+\newcommand\revdate{  21 February 2015  }  %date you are completing the review
+
+%SCOPE
+\newcommand\goals{  a,b,c  }  %brief but complete list of goals for the code under review
+\newcommand\goalsAppropriate{  y/n  } %Are these goals appropriate for this code -- yes or no?
+\newcommand\goalsMet{  y/n  } %Were all goals met -- yes or no?
+\newcommand\goalsComments{  asdf  } %Comments about goals and scope
+
+%COMPILATION
+\newcommand\compileSuccess{  y/n  } %Does the code compile -- yes or no?
+\newcommand\compileComments{  asdf  }  %Comments about compilation
+
+%TESTING
+\newcommand\testSuccess{  y/n  } %Does the code pass the provided tests -- yes or no?
+\newcommand\testGeneral{  y/n  } %Do the provided tests adequately measure general circumstances -- yes or no?
+\newcommand\testEdge {  y/n  } %Do the provided tests adequately include edge cases -- yes or no?
+\newcommand\testComments{  asdf  } %Comments about tests
+
+%DOCUMENTATION
+\newcommand\docAdequate{  y/n  } %Is the code adequately commented -- yes or no?
+\newcommand\docComments{  asdf  }  %Comments about documentation
+
+%STYLE
+\newcommand\styleAdequate{  y/n  } %Does the code conform adequately to the b2 style conventions -- yes or no?
+\newcommand\styleComments{  asdf  } %Comments about style
+
+%OTHER COMMENTS
+\newcommand\otherComments{  asdf  } %Other comments
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%% END OF REVIEWER SECTION %%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+
+
+
+\newcommand\bb{{bertini2\ }}
+
+\begin{document}
+
+\noindent
+{\bf \bb review}\\
+Code: \class\\
+Reviewer:  \you \\
+Date:  \revdate
+
+\noindent\hrulefill
+
+\noindent
+{\bf Scope}
+
+\noindent
+\underbar{Goals}: \goals
+
+\noindent
+\underbar{Are these goals appropriate}? \goalsAppropriate
+
+\noindent
+\underbar{Were these goals met}? \goalsMet
+
+\noindent
+\underbar{Comments}: \\ \goalsComments
+
+\noindent\hrulefill
+
+
+
+\noindent
+{\bf Compilation}
+
+\noindent
+\underbar{Does the code compile?} \compileSuccess
+
+\noindent
+\underbar{Comments}:\\ \compileComments
+
+\noindent\hrulefill
+
+
+
+\noindent
+{\bf Testing}
+
+\noindent
+\underbar{Does the code pass the provided tests?} \testSuccess
+
+\noindent
+\underbar{Do the provided tests adequately measure general circumstances?} \testGeneral
+
+\noindent
+\underbar{Do the provided tests adequately include edge cases?} \testEdge
+
+\noindent
+\underbar{Comments}: \\ \testComments
+
+\noindent\hrulefill
+
+
+
+\noindent
+{\bf Documentation}
+
+\noindent
+\underbar{Is the code adequately commented?} \docAdequate
+
+\noindent
+\underbar{Comments}: \\ \docComments
+
+\noindent\hrulefill
+
+
+
+\noindent
+{\bf Style}
+
+\noindent
+\underbar{Does the code conform adequately to the b2 style conventions?} \styleAdequate
+
+\noindent
+\underbar{Comments}:\\ \styleComments
+
+\noindent\hrulefill
+
+
+
+\noindent
+{\bf Other comments}\\  \otherComments
+
+
+\end{document}

core/doc/generated_documentation/.gitignore

@@ -0,0 +1 @@
+[^.]*

core/doc/images_common

@@ -0,0 +1 @@
+../../doc_resources/images/