Commit afa0154
committed
docs(sync[update_repo]): Document SyncResult return type in README and base class
why: README showed a bare update_repo() call that ignored errors, and
BaseSync.update_repo() docstring lacked a Returns section for autodoc.
what:
- Update README sync example to capture SyncResult and check .ok/.errors
- Add NumPy-style Returns section to BaseSync.update_repo() docstring1 parent 6c7a660 commit afa0154
2 files changed
Lines changed: 13 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
70 | 70 | | |
71 | 71 | | |
72 | 72 | | |
73 | | - | |
| 73 | + | |
74 | 74 | | |
75 | | - | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
76 | 80 | | |
77 | 81 | | |
78 | 82 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
278 | 278 | | |
279 | 279 | | |
280 | 280 | | |
281 | | - | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
282 | 288 | | |
283 | 289 | | |
284 | 290 | | |
| |||
0 commit comments