Commit 52195ad
authored
Be explicit about leading * when documenting *args, **kwargs. (#310)
This seem to be what most docstring involving args/kwargs are doing
including the example.py; Though I've seen other project be less
consistant, so make the suggestion explicit instead of letting users
infer from the example.
Other convention I've seen are:
- `*xi` , documented as `x1,x2, ..., xn : type`
- just the name without the leading `*`/`**`.
- prefixing `*` with `\\*`.1 parent 26850f7 commit 52195ad
1 file changed
+12
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
213 | 213 | | |
214 | 214 | | |
215 | 215 | | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
216 | 228 | | |
217 | 229 | | |
218 | 230 | | |
| |||
0 commit comments