test: Fix Python Docstring to include all Args. #17030

pull jbampton wants to merge 1 commits into bitcoin:master from jbampton:fix-python-docstring changing 1 files +2 −1

jbampton commented at 8:42 PM on October 2, 2019: contributor

Found a Python function that had incorrect and missing arguments in its Docstring.
fanquake added the label Docs on Oct 2, 2019
fanquake added the label Tests on Oct 2, 2019
jbampton renamed this:
~~Fix Python Docstring to include all Args.~~
test: Fix Python Docstring to include all Args.
on Oct 2, 2019
MarcoFalke commented at 8:47 PM on October 2, 2019: member

Might as well insert a , *, before timeout in the function signature to enforce named args?
jbampton force-pushed on Oct 2, 2019
Fix Python Docstring to include all Args. 8acd58927a
in test/functional/test_framework/util.py:253 in 4f6a65d621 outdated
```
 249 |      """
 250 |      Args:
 251 |          url (str): URL of the RPC server to call
 252 |          node_number (int): the node number (or id) that this calls to
 253 | -
 254 | -    Kwargs:
```
laanwj commented at 1:31 PM on October 4, 2019:

Any reason to remove "Kwargs" here? Especially with the *, it seems important to mention that these need to be keyword arguments.

jbampton commented at 12:40 AM on October 6, 2019:

I put Kwargs: back now.
jbampton force-pushed on Oct 6, 2019
laanwj commented at 8:27 AM on October 8, 2019: member

ACK 8acd58927a614e006641384f61f8e7fca1cc68fc
laanwj referenced this in commit 866fd2888f on Oct 8, 2019
laanwj merged this on Oct 8, 2019
laanwj closed this on Oct 8, 2019
sidhujag referenced this in commit 6bec5db5e6 on Oct 8, 2019
jbampton deleted the branch on Oct 14, 2019
MarkLTZ referenced this in commit 8823f65197 on Apr 7, 2020
MarkLTZ referenced this in commit 0a1571d657 on Apr 7, 2020
jasonbcox referenced this in commit d559101996 on Oct 25, 2020
PastaPastaPasta referenced this in commit 2fba4656cf on Jun 27, 2021
PastaPastaPasta referenced this in commit fbc5d67aed on Jun 28, 2021
PastaPastaPasta referenced this in commit c658ecae20 on Jun 29, 2021
PastaPastaPasta referenced this in commit 994bfb14ea on Jul 1, 2021
PastaPastaPasta referenced this in commit 3b06fa3e7f on Jul 1, 2021
PastaPastaPasta referenced this in commit 2dd71d2099 on Jul 12, 2021
PastaPastaPasta referenced this in commit d5f63210e3 on Jul 13, 2021
PastaPastaPasta referenced this in commit 3d8cb7b430 on Jul 13, 2021
MarcoFalke locked this on Dec 16, 2021

Contributors

Labels