Commit 889aa0f
Soham Dahivalkar
docs: add missing docstrings to core public API methods
Add docstrings to undocumented public methods in the client and server
session modules:
- ClientSession.initialize(): document handshake flow, return type, and
RuntimeError on unsupported protocol version
- ServerSession.client_params: document property returning client's
InitializeRequestParams
- ServerSession.incoming_messages: document the ServerRequestResponder
stream property
- remove_request_params(): document URL query-stripping utility
These are the most user-facing public methods that currently lack
docstrings, making IDE tooltips and help() output incomplete.1 parent 616476f commit 889aa0f
3 files changed
Lines changed: 29 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
146 | 146 | | |
147 | 147 | | |
148 | 148 | | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
149 | 163 | | |
150 | 164 | | |
151 | 165 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
21 | 26 | | |
22 | 27 | | |
23 | 28 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
107 | 107 | | |
108 | 108 | | |
109 | 109 | | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
110 | 115 | | |
111 | 116 | | |
112 | 117 | | |
| |||
689 | 694 | | |
690 | 695 | | |
691 | 696 | | |
| 697 | + | |
| 698 | + | |
| 699 | + | |
| 700 | + | |
| 701 | + | |
692 | 702 | | |
0 commit comments