components/logilab-astng/logilab-astng.3
changeset 1023 d2db2bc970c3
parent 181 87e11e685b1f
--- a/components/logilab-astng/logilab-astng.3	Sat Oct 20 13:01:48 2012 -0700
+++ b/components/logilab-astng/logilab-astng.3	Mon Oct 22 10:02:22 2012 -0700
@@ -1,53 +1,52 @@
 .\"
-.\" Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved.
+.\" Copyright (c) 2009, 2012, Oracle and/or its affiliates. All rights reserved.
 .\"
 .\" logilab-astng.3
 .\"
-.TH logilab-astng 3 "30 Apr 2009"
+.TH logilab-astng 3 "18 Jul 2012" "logilab-astng 0.24.0"
 .SH NAME
 logilab-astng \- Python Abstract Syntax Tree New Generation
 .SH DESCRIPTION
-The
-.I logilab-astng
+
 The aim of this module is to provide a common base representation of 
 python source code for projects such as pychecker, pyreverse, pylint.
 
 .LP
-It is governed by pylint's needs.  It extends class defined in the 
-compiler.ast [1] module with some additional methods and attributes. 
-Instance attributes are added by a builder object, which can either 
-generate extended ast by visiting an existant ast tree or by inspecting 
-living object. Methods are added by monkey patching ast classes.
+It provides a compatible representation which comes from the `_ast` module.
+It rebuilds the tree generated by the builtin _ast module by recursively
+walking down the AST and building an extended ast (let's call it astng ;). The
+new node classes have additional methods and attributes for different usages.
+They include some support for static inference and local name scopes.
+Furthermore, astng builds partial trees by inspecting living objects.
 
 .LP
 Main modules are:
 .LP
 
-* nodes and scoped_nodes for more information about methods 
-and attributes added to different node classes
+* `bases`, `node_classses` and `scoped_nodes` contain the classes for the different type of nodes of the tree.
 
 .LP
-* the manager contains a high level object to get astng trees 
-from source files and living objects. It maintains a cache of 
-previously constructed tree for quick access
-
-.LP
-* builder contains the class responsible to build astng trees
-
+* the `manager` contains a high level object to get astng trees from source files and living objects. It maintains a cache of previously constructed tree for quick access
 
 .LP
 
 .SH FILES
 .TP 2.2i
 .B /usr/lib/python2.6/vendor-packages/logilab/astng
-shared object library files
+logilab-astng python modules
+.TP
+.B /usr/lib/python2.7/vendor-packages/logilab/astng
+logilab-astng python modules
 
 .SH AUTHORS
 Sylvain Thenault ([email protected])
 
 .SH SUPPORT
[email protected]
+If you have any questions, please mail the
[email protected] mailing list for support. See
+http://lists.logilab.org/mailman/listinfo/python-projects for
+subscription information and archives.
 
 .SH SEE ALSO
 .IR logilab-common (3),
-.IR pylint (1),
+.IR pylint (1)