summaryrefslogtreecommitdiff
path: root/astroid/nodes.py
diff options
context:
space:
mode:
authorAshley Whetter <ashley@awhetter.co.uk>2017-10-15 21:25:40 -0700
committerAshley Whetter <AWhetter@users.noreply.github.com>2017-11-05 12:18:24 -0800
commit206b4f4494e4ac4f5fe98a85381c63da24901970 (patch)
treef6e5b7ae989dc1d5b9224f3fd33071f4c941f5be /astroid/nodes.py
parentd86cbd38b9e614948796c4121f1c43cb44bdb0a8 (diff)
downloadastroid-git-206b4f4494e4ac4f5fe98a85381c63da24901970.tar.gz
Public facing node documentation
Diffstat (limited to 'astroid/nodes.py')
-rw-r--r--astroid/nodes.py20
1 files changed, 4 insertions, 16 deletions
diff --git a/astroid/nodes.py b/astroid/nodes.py
index 2b207d02..f9399a56 100644
--- a/astroid/nodes.py
+++ b/astroid/nodes.py
@@ -6,24 +6,12 @@
# Licensed under the LGPL: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html
# For details: https://github.com/PyCQA/astroid/blob/master/COPYING.LESSER
-"""
-on all nodes :
- .is_statement, returning true if the node should be considered as a
- statement node
- .root(), returning the root node of the tree (i.e. a Module)
- .previous_sibling(), returning previous sibling statement node
- .next_sibling(), returning next sibling statement node
- .statement(), returning the first parent node marked as statement node
- .frame(), returning the first node defining a new local scope (i.e.
- Module, FunctionDef or ClassDef)
- .set_local(name, node), define an identifier <name> on the first parent frame,
- with the node defining it. This is used by the astroid builder and should not
- be used from out there.
-
-on ImportFrom and Import :
- .real_name(name),
+"""Every available node class.
+.. seealso::
+ :doc:`ast documentation <green_tree_snakes:nodes>`
+All nodes inherit from :class:`~astroid.node_classes.NodeNG`.
"""
# pylint: disable=unused-import,redefined-builtin