You are here

?omxConstraintRelations no documentation for

?omxConstraintRelations
No documentation for 'omxConstraintRelations' in specified packages and libraries:
you could try '??omxConstraintRelations'

Reporter: 
Created: 
Tue, 06/08/2010 - 15:05
Updated: 
Tue, 06/08/2010 - 15:39

Comments

We don't have documentation for all of the omx() functions. Originally omx() functions were supposed to be for functions that could change behavior in between binary releases of the project. That's not exactly true anymore, since we have omxAllInt(), omxApply(), omxMnor(), etc. that we don't intend to change their APIs. In this specific instance, is their a need to document omxConstraintRelations? It's just a list of "<", "==", and ">". It shouldn't really be necessary for the user. The documentation they need is in ?mxConstraint.

I forgot to add: it's better not use R documentation for functions that we don't want exposed to the user, rather then documenting all the functions and then increase the probably of stale documentation. In other words, I maintain that no documentation is better than stale documentation for non-exposed functions.

makes sense. perhaps a universal omx stub "used internally" or something so that people don't get simple not found errors?