-
Notifications
You must be signed in to change notification settings - Fork 0
pythonizing initial review
As of December 11, 2019, the Pythonizing group:
- Finished Pythonizing the entire MPI doc (on the
mpi-4.x
branch) - Finished a 1st pass checking for correctness of the results
It is now time to ask the chapter committees to review our work. We are asking you to check four things as compared to the mpi-4.x
branch HEAD:
- We Pythonized the bindings correctly (without embiggening): the generated PDF contains correct bindings
- You'll want to
make clean; make cleandoc
(ormake 3cleandoc
to explicitly build the Pythonized doc without embiggening)
- You'll want to
- We didn't accidentally delete anything
- We didn't accidentally add anything
- We didn't accidentally edit anything
- We embiggened parameters correctly
- You'll want to
make clean; make 4cleandoc
to explicitly build with Pythonization and embiggening
- You'll want to
Note that there are acceptable LaTeX rendering differences between the mpi-4.x
HEAD and the result of this work. See these slides (presented at the Dec 2019 MPI Forum physical meeting) for the types of differences you can expect to see.
The slides also mention a tool you can use to help compare the LaTeX from the mpi-4.x
HEAD to the Python-generated LaTeX on our pull request -- see this wiki page for instructions. This tool can greatly simplify your correctness check.
Once you have completed your check:
- If you have any corrections to make, please feel free to add git commits to this PR with the fixes.
- Alternatively, you can email us with your corrections.
- After that, please fill in an "X" in the corresponding row/column in this Google sheet indicating that you have completed your review.
NOTE: Jeff said in the ABQ MPI Forum meeting that chapter committees would be committing approvals.json
and pull-requesting it back to the repo to indicate that you had completed your review. That has now changed. We later decided that it would be significantly easier to just mark off in the Google sheet that you have completed your review.