diff options
| author | Ulf Magnusson <ulfalizer@gmail.com> | 2019-05-23 09:49:42 +0200 |
|---|---|---|
| committer | Ulf Magnusson <ulfalizer@gmail.com> | 2019-05-23 09:49:42 +0200 |
| commit | 95515d4cb09c02881bfbec1809c82f885ebd55c8 (patch) | |
| tree | c7a1fc133e645d61a5d1723f4ef60d29a318c38b /kconfiglib.py | |
| parent | 7e0b9f7ae124e87c706bfa6f7b467e67215d3fca (diff) | |
Clarify that KconfigSyntaxError = KconfigError in the docs
KconfigSyntaxError is just an older (bad) name. pydoc generates
confusing documentation due to the "KconfigSyntaxError = KconfigError"
assignment, so mention it in the docstring.
Diffstat (limited to 'kconfiglib.py')
| -rw-r--r-- | kconfiglib.py | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/kconfiglib.py b/kconfiglib.py index 4083110..4a58669 100644 --- a/kconfiglib.py +++ b/kconfiglib.py @@ -5479,7 +5479,12 @@ class Variable(object): class KconfigError(Exception): - "Exception raised for Kconfig-related errors" + """ + Exception raised for Kconfig-related errors. + + KconfigError and KconfigSyntaxError are the same class. The + KconfigSyntaxError alias is only maintained for backwards compatibility. + """ KconfigSyntaxError = KconfigError # Backwards compatibility |