Skip to content

Commit fdc70c3

Browse files
committed
Update / generalise some docstrings
1 parent 8c03499 commit fdc70c3

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

flattentool/sort_iati.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
"""
2-
Sorts an IATI XML file according to the schema. This is most useful for 2.0x
3-
where that ordering is required.
2+
Sort an XML file according to one or more provided schemas.
43
54
Based on https://github.com/OpenDataServices/iati-utils/blob/master/sort_iati.py
65
@@ -44,8 +43,7 @@
4443

4544
class IATISchemaWalker(object):
4645
"""
47-
Class for converting an IATI XML schema to documentation in the
48-
reStructuredText format.
46+
Class for traversing one or more XML schemas.
4947
5048
Based on the Schema2Doc class in https://github.com/IATI/IATI-Standard-SSOT/blob/version-2.02/gen.py
5149
"""
@@ -109,7 +107,7 @@ def element_loop(self, element, path):
109107
def create_schema_dict(self, parent_name, parent_element=None):
110108
"""
111109
Create a nested OrderedDict representing the structure (and order!) of
112-
elements in the IATI schema.
110+
elements in the provided schema.
113111
"""
114112
if parent_element is None:
115113
parent_element = self.get_schema_element('element', parent_name)

0 commit comments

Comments
 (0)