From 95515d4cb09c02881bfbec1809c82f885ebd55c8 Mon Sep 17 00:00:00 2001 From: Ulf Magnusson Date: Thu, 23 May 2019 09:49:42 +0200 Subject: 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. --- kconfiglib.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) 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 -- cgit v1.2.3