Commit fdebea0
authored
Remove literal type alias to help sphinx render (#1129)
This type alias is used in 3 locations (two of which are internal),
but sphinx autodoc does not render it as desired or expected. It seems
that there's something more complex going wrong with the docstring for
this class, but it may also be related to some outstanding sphinx bugs
related to type aliases and literals, specifically.
For now, switch off of the alias and use the literal verbatim in
`TransferData.__init__` to get a rendering which is much closer to
being correct.1 parent f434f8e commit fdebea0
1 file changed
+7
-4
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
14 | | - | |
15 | | - | |
| 14 | + | |
16 | 15 | | |
17 | 16 | | |
18 | 17 | | |
19 | 18 | | |
20 | 19 | | |
21 | 20 | | |
22 | 21 | | |
23 | | - | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
24 | 25 | | |
25 | 26 | | |
26 | 27 | | |
| |||
168 | 169 | | |
169 | 170 | | |
170 | 171 | | |
171 | | - | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
172 | 175 | | |
173 | 176 | | |
174 | 177 | | |
| |||
0 commit comments