Document LocaleScanner's constructor

I needed to know in order to make recent changes.
Save the need to work it out again next time.

Change-Id: Ibc606cbe2e6af16e6820fd753a643331a03cdfb3
Reviewed-by: Ievgenii Meshcheriakov <ievgenii.meshcheriakov@qt.io>
This commit is contained in:
Edward Welbourne 2024-01-17 18:42:58 +01:00
parent 00d9a9a9b5
commit a736e613fc

View File

@ -198,6 +198,13 @@ class Supplement (XmlScanner):
class LocaleScanner (object):
def __init__(self, name, nodes, root):
"""Set up to scan data for a specified locale.
First parameter is the name of the locale; it will be used in
error messages. Second is a tuple of DOM root-nodes of files
with locale data, later ones serving as fall-backs for data
missing in earlier ones. Third parameter is the root locale's
DOM node."""
self.name, self.nodes, self.base = name, nodes, root
def find(self, xpath, default = None, draft = None):