Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open

Conversation

demitri
Copy link
Contributor

@demitri demitri commented Apr 22, 2015

No description provided.

@dsberry
Copy link
Member

dsberry commented Apr 24, 2015

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants