Subject to the remediation in #60, the doc strings in graph.pyx and g6IterationUtils.pyx are useful for generating Python API documentation.
If those doc strings were copied to graphLib.pyx, they could be used as the basis creating C-layer public API documentation for EAPS.
The main changes would be
- Each method would need a first arg for
theGraph (or occasionally, theEmbedding)
- Many methods would need a Returns component to indicate OK versus NOTOK. Methods that already return a value would need to have NOTOK added.
- The Raises components would have to be removed.
These are main changes, though there will be a few odd cases. For example, gp_DrawPlanar_RenderToString() would need to have its Args and Returns described differently than in Python due to returning OK/NOTOK and returning also a string as an output argument.
Subject to the remediation in #60, the doc strings in
graph.pyxandg6IterationUtils.pyxare useful for generating Python API documentation.If those doc strings were copied to
graphLib.pyx, they could be used as the basis creating C-layer public API documentation for EAPS.The main changes would be
theGraph(or occasionally,theEmbedding)These are main changes, though there will be a few odd cases. For example,
gp_DrawPlanar_RenderToString()would need to have its Args and Returns described differently than in Python due to returning OK/NOTOK and returning also a string as an output argument.