summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorUlf Magnusson <ulfalizer@gmail.com>2017-09-24 20:02:43 +0200
committerUlf Magnusson <ulfalizer@gmail.com>2017-09-25 13:22:56 +0200
commit55f00fdd55ec20ea5597b8144f4ea3e59a33efe0 (patch)
treec70c0bc00d26f96ff1f47f43628710e69c95fe31 /README.rst
parent0c15b8e123c60133ba17932567cc848c44da76ee (diff)
Prefix module- and class-internal names with _
I didn't do this when I first wrote Kconfiglib, for whatever reason. Makes the public API clearer to people browsing the code (though it was already done for function names) and has some other nice side effects like uncluttering the module-level documentation and making autocompletion in ipython more useful. Might avoid pissing off some people too. Remove the trailing from _ from stuff that no longer clashes with keywords. Piggyback some formatting cleanups for stuff I happened to spot. It's a huge unwieldy diff anyway.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 2098845..4757d82 100644
--- a/README.rst
+++ b/README.rst
@@ -140,7 +140,7 @@ Notes
* **Useful information can be extracted from internal data structures.** The
expression format is pretty simple for example: ``A && B && (!C || D == 3)`` is
represented as the tuple structure
- ``(AND, A, (AND, B, (OR, (NOT, C), (EQUAL, D, 3))))``; see the
+ ``(_AND, A, (_AND, B, (_OR, (_NOT, C), (_EQUAL, D, 3))))``; see the
``Config._parse_expr()`` docstring.
It's hard to come up with good APIs for dealing with expressions given how