From 813b66a3bc1ad6ee88f91c42093e33a9e93aefd4 Mon Sep 17 00:00:00 2001
From: Ulf Magnusson <ulfalizer@gmail.com>
Date: Fri, 19 Jun 2015 06:13:57 +0200
Subject: Make the _parse_expr() docstring more informative.

---
 kconfiglib.py | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'kconfiglib.py')

diff --git a/kconfiglib.py b/kconfiglib.py
index 99cb8b0..ad6f6fb 100644
--- a/kconfiglib.py
+++ b/kconfiglib.py
@@ -781,9 +781,11 @@ class Config(object):
 
     def _parse_expr(self, feed, cur_item, line, filename=None, linenr=None,
                     transform_m=True):
-        """Parse an expression from the tokens in 'feed' using a simple
-        top-down approach. The result has the form (<operator>, <list
-        containing parsed operands>).
+        """Parses an expression from the tokens in 'feed' using a simple
+        top-down approach. The result has the form
+        '(<operator>, [<parsed operands>])', where <operator> is e.g.
+        kconfiglib.AND. If there is only one operand (i.e., no && or ||), then
+        the operand is returned directly. This also goes for subexpressions.
 
         feed: _Feed instance containing the tokens for the expression.
 
-- 
cgit v1.2.3