Skip to content

Commit be0603b

Browse files
committed
better comments
1 parent 381db1a commit be0603b

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

GDL.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ def get_project_data(view, invoke):
4646
def get_project_newroot(view):
4747
""" Gets the data of the .sublime-project file.
4848
Returns a relative path, if set.
49-
(Useful, if you have many subfolders.)
49+
(Useful, if you have many subfolders and want to assign
50+
a new root, where all the objects are in.)
5051
"""
5152
try:
5253
project_data = view.window().project_data()
@@ -113,6 +114,7 @@ def check_system(self):
113114
def normpath(self, path):
114115
""" Normalize a pathname by collapsing redundant separators.
115116
On Windows, it converts forward slashes to backward slashes.
117+
Returns the object as an quote encapsulated string.
116118
"""
117119
return '"{}"'.format(os.path.normpath(path))
118120

@@ -167,10 +169,13 @@ def delegator(self):
167169
# http://gdl.graphisoft.com/tips-and-tricks/how-to-use-the-lp_xmlconverter-tool
168170
# for detailed information
169171
class HsfBuildCommand(Builder):
170-
""" Converts a GSM into human readable GDL scripts. """
172+
""" Converts a GSM into human readable GDL scripts via the LP_XMLConverter. """
171173

172174
def run(self, *args, **kwargs):
173-
""" Sublime Text will call this function. """
175+
""" Sublime Text will call this function.
176+
We will run the parent class "Builder" first.
177+
That will give us all the parameters we need.
178+
"""
174179
super().run(self)
175180

176181
def on_done_proj(self):

0 commit comments

Comments
 (0)