I’m considering a project to make the documentation more uniform by using standard names and case for scalars, vectors, and matrices. My proposal, similar to what Matlab does, is that matrices are uppercase and begin with A, B, … We mostly do this for the linear algebra core functions, but not everywhere.
Scalars and vectors would be lowercase and generally chosen from the set of x, y, z, t, w.
This would also involve renaming variables in m-files so the that the code matched the documentation.
- Matches many linear algebra textbook conventions
- Uniform documentation would make it easy to understand new functions
- One could tell at a glance whether a matrix or scalar was desired input
- Work required to convert core functions
Any opinions on whether this is a good idea to pursue?