Documentation Verification

[davidcbhunter]

I recently ran into an issue involving the Page.insert_text function, where the documented order of arguments did not match the order of arguments in the source code.

My brother is a contributor to OpenMX, and he noted that they have automated a certain level of documentation verification for their project. For example, if you write a function and document it, you will not be able to commit these changes unless a few conditions are met. For example, the number, types, and order of arguments in the code and documentation must match.

I don't know how much work would be involved in implementing this, but having some basic documentation verification would go a long way to prevent such woes during future changes. What does everyone think of this idea? Would this entail an unreasonable amount of work?