Skip to content

Commit 84463c4

Browse files
committed
Fix regression with incorrect args order in docs
1 parent b1b0c83 commit 84463c4

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

describe.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,7 @@ def method_params(doc):
215215
args = doclines[begin + 1 :]
216216

217217
parameters = []
218+
sorted_parameters = []
218219
pname = None
219220
desc = ""
220221

@@ -223,7 +224,11 @@ def add_param(pname, desc):
223224
return
224225
if "(required)" not in desc:
225226
pname = pname + "=None"
226-
parameters.append(pname)
227+
parameters.append(pname)
228+
else:
229+
# required params should be put straight into sorted_parameters
230+
# to maintain order for positional args
231+
sorted_parameters.append(pname)
227232

228233
for line in args:
229234
m = re.search(r"^\s+([a-zA-Z0-9_]+): (.*)", line)
@@ -234,10 +239,11 @@ def add_param(pname, desc):
234239
pname = m.group(1)
235240
desc = m.group(2)
236241
add_param(pname, desc)
237-
parameters = ", ".join(sorted(parameters))
242+
sorted_parameters.extend(sorted(parameters))
243+
sorted_parameters = ", ".join(sorted_parameters)
238244
else:
239-
parameters = ""
240-
return parameters
245+
sorted_parameters = ""
246+
return sorted_parameters
241247

242248

243249
def method(name, doc):

0 commit comments

Comments
 (0)