Commit f132248
committed
docs: address Copilot review on #241
Four fixes raised in Copilot's review of #241:
- Spond class example: guard `await s.get_groups()` with `or []` so
iterating the result is safe when the account has no groups (the
return type is documented as `list[JSONDict] | None`).
- `get_events()` docstring: removed the forward-looking claim that
`get_event(uid)` "queries the singular endpoint directly" — that's
only true after #236 lands. Replaced with current behavior plus
reference to #236 as the planned change.
- `get_events()` `subgroup_id` parameter: docstring said `subgroupId`
API parameter, but the code sends `subGroupId` (capital G, line
387). Aligned the docstring with the actual API param.
- `update_event()` Returns section: was declared `JSONDict` but the
method (due to known bug #239) currently returns `self.events`, a
`list[JSONDict] | None`. Updated the Returns type to match the
current contract, with the bug and workaround called out in Notes.1 parent 2622a1a commit f132248
1 file changed
Lines changed: 22 additions & 11 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
55 | | - | |
| 55 | + | |
56 | 56 | | |
57 | 57 | | |
58 | 58 | | |
| |||
452 | 452 | | |
453 | 453 | | |
454 | 454 | | |
455 | | - | |
456 | | - | |
457 | | - | |
| 455 | + | |
| 456 | + | |
| 457 | + | |
| 458 | + | |
| 459 | + | |
| 460 | + | |
| 461 | + | |
458 | 462 | | |
459 | 463 | | |
460 | 464 | | |
461 | 465 | | |
462 | 466 | | |
463 | 467 | | |
464 | 468 | | |
465 | | - | |
| 469 | + | |
466 | 470 | | |
467 | 471 | | |
468 | 472 | | |
| |||
588 | 592 | | |
589 | 593 | | |
590 | 594 | | |
591 | | - | |
592 | | - | |
593 | | - | |
594 | | - | |
| 595 | + | |
| 596 | + | |
| 597 | + | |
| 598 | + | |
595 | 599 | | |
596 | 600 | | |
597 | 601 | | |
598 | | - | |
599 | | - | |
| 602 | + | |
| 603 | + | |
| 604 | + | |
| 605 | + | |
| 606 | + | |
| 607 | + | |
| 608 | + | |
| 609 | + | |
| 610 | + | |
600 | 611 | | |
601 | 612 | | |
602 | 613 | | |
| |||
0 commit comments