Starlink / starlink-pyast

Python interface to the Starlink AST library
http://www.starlink.ac.uk/ast
12 stars 8 forks source link

List the possible "oper" values in the astOutline function. #4

Open demitri opened 9 years ago

dsberry commented 9 years ago

Thanks for that. But as things are at the moment, the "make_doc" script generates node1.html automatically from the Ast.c file. So node1.html should not be changed manually. See the README for the gh-pages branch. In order to see changes in node1.html, node2.html or pyast.html, the required changes should be made to starlink/ast/Ast.c (on master) and the html re-generated by running make_doc (on gh-pages), as described in the gh-pages README.

The usual way is to search Ast.c for the method definition ("PyAst_outline" in this case ) and add a "note" comment to it, as in

/* Note: The "oper" parameter takes a constant from the list: Ast.LE, Ast.EQ, Ast.GT, Ast.LT, Ast.NE, Ast.GE, Ast.GT */

then re-generate node1.html using make_doc on gh_pages.

Clearly, the documentation for Pyast is an area where there is a lot of scope for improvement. The current scheme is a product of running out of time on the original project!